Difference between revisions of "OpenFOAM guide/Programmer's Guide Errata"
From OpenFOAMWiki
(Added the missing typo for the first link, namely subsection 2.1.2) |
(Indicated that there is also a local copy of the guide and did some visibility tweaks to the "notes for contributors") |
||
Line 1: | Line 1: | ||
− | Community created ''Errata'' for the [http://foam.sourceforge.net/docs/Guides-a4/ProgrammersGuide.pdf OpenFOAM ''Programmer's Guide'']. | + | Community created ''Errata'' for the OpenFOAM ''Programmer's Guide'': |
+ | * Online version: [http://foam.sourceforge.net/docs/Guides-a4/ProgrammersGuide.pdf OpenFOAM ''Programmer's Guide'' at SF.net] | ||
+ | * The local version in your OpenFOAM installation can be found by running this command: <bash>echo $WM_PROJECT_DIR/doc/Guides-a4/ProgrammersGuide.pdf</bash> | ||
− | Notes to contributors: Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers) | + | <br> |
+ | <hr> | ||
+ | '''Notes to contributors:''' Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers) | ||
+ | <hr> | ||
+ | <br> | ||
= Chapter 1: Tensor mathematics = | = Chapter 1: Tensor mathematics = | ||
Line 98: | Line 104: | ||
<br> | <br> | ||
− | = Known threads on this topic = | + | = Known forum threads on this topic = |
This is a unordered list of links to threads about typos and errors in the ''Programmer's Guide'' that have been found by the community: | This is a unordered list of links to threads about typos and errors in the ''Programmer's Guide'' that have been found by the community: | ||
Revision as of 12:48, 15 September 2013
Community created Errata for the OpenFOAM Programmer's Guide:
- Online version: OpenFOAM Programmer's Guide at SF.net
- The local version in your OpenFOAM installation can be found by running this command:
echo $WM_PROJECT_DIR/doc/Guides-a4/ProgrammersGuide.pdf
Notes to contributors: Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers)
Contents
1 Chapter 1: Tensor mathematics
1.1 Section 1.4: OpenFOAM tensor classes
1.1.1 Subsection 1.4.1: Algebraic tensor operations in OpenFOAM
In Table 1.2: Algebraic tensor operations in OpenFOAM, the following entries need fixing:
Operation | Description in OpenFOAM (wrong) |
Description in OpenFOAM (correct) |
---|---|---|
Component maximum | max(a) | cmptMax(a) |
Component minimum | min(a) | cmptMin(a) |
Scale | scale(a,b) | cmptMultiply(a,b) |
2 Chapter 2: Discretisation procedures
2.1 Section 2.1: Differential operators
2.1.1 Subsection 2.1.2: Divergence
The documented divergence operator for tensors is incorrect:
It should be:
2.2 Section 2.4: Equation discretisation
2.2.1 Subsection 2.4.6: Gradient
- All references to timeScheme should be either gradSchemes or snGradSchemes [1].
- The indication of [Check**] implies that this subsection needs to be revised.
2.2.2 Subsection 2.6.1: Physical boundary conditions
- The indication of [Check**] implies that this subsection needs to be revised.
3 Chapter 3: Examples of the use of OpenFOAM
4 Chapter 4: Programming techniques
5 Known forum threads on this topic
This is a unordered list of links to threads about typos and errors in the Programmer's Guide that have been found by the community:
- Bug in the programmer's guide: divergence of a tensor field
- Documented in Subsection 2.1.2: Divergence, but keep in mind that this has already been fixed.
- In Programmer's Guide p. 40
- The issues in post #1 are at Subsection 2.4.6: Gradient and Subsection 2.6.1: Physical boundary conditions
- Programmers Guide Bugs
- The issues indicated in post #1 are already here in the wiki in the subsection Subsection 1.4.1 Algebraic tensor operations in OpenFOAM.
- Error in documentation