Difference between revisions of "OpenFOAM guide/Programmer's Guide Errata"
(Indicated that there is also a local copy of the guide and did some visibility tweaks to the "notes for contributors") |
(revised page and updated a few links) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
Community created ''Errata'' for the OpenFOAM ''Programmer's Guide'': | Community created ''Errata'' for the OpenFOAM ''Programmer's Guide'': | ||
− | * Online version: [ | + | * Online version: [https://sourceforge.net/projects/openfoamplus/files/v1606+/ProgrammersGuide-v1606.pdf OpenFOAM ''Programmer's Guide'' at SF.net] |
− | * The local version in your | + | * The local version in your installation can be found by running one of the respective commands: |
+ | ** On OpenFOAM 3.0 and older, as well as foam-extend and all OpenFOAM+ versions: <bash>echo $WM_PROJECT_DIR/doc/Guides-a4/ProgrammersGuide.pdf</bash> | ||
+ | ** As of OpenFOAM 4, there is no Programmer's Guide. This is now maintained by the [http://openfoam.com OpenFOAM+ project]. | ||
<br> | <br> | ||
Line 10: | Line 12: | ||
= Chapter 1: Tensor mathematics = | = Chapter 1: Tensor mathematics = | ||
+ | |||
+ | |||
+ | == Section 1.2: Tensors == | ||
+ | |||
+ | As reported in the [http://bugs.openfoam.org/view.php?id=1068 bug report #1068], there are a couple of references to ''OpenFOAM 1.x'', which is likely an old reference to the original FOAM 2.x version. Feel free to compare to the old documentation at Nabla: the old Programmer's Guide, section [http://www.foamcfd.org/Nabla/guides/ProgrammersGuidese2.html#x5-40001.2 1.2 Tensors]. | ||
+ | |||
+ | Either way, feel free to disregard the ''1.x'' reference, since its objective is reflect that tensors as a mathematical entity, are only partially implemented in OpenFOAM. | ||
Line 28: | Line 37: | ||
| Scale || scale(a,b) || cmptMultiply(a,b) | | Scale || scale(a,b) || cmptMultiply(a,b) | ||
|} | |} | ||
− | |||
= Chapter 2: Discretisation procedures = | = Chapter 2: Discretisation procedures = |
Latest revision as of 13:38, 20 August 2016
Community created Errata for the OpenFOAM Programmer's Guide:
- Online version: OpenFOAM Programmer's Guide at SF.net
- The local version in your installation can be found by running one of the respective commands:
- On OpenFOAM 3.0 and older, as well as foam-extend and all OpenFOAM+ versions:
echo $WM_PROJECT_DIR/doc/Guides-a4/ProgrammersGuide.pdf
- As of OpenFOAM 4, there is no Programmer's Guide. This is now maintained by the OpenFOAM+ project.
- On OpenFOAM 3.0 and older, as well as foam-extend and all OpenFOAM+ versions:
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.2: Tensors
As reported in the bug report #1068, there are a couple of references to OpenFOAM 1.x, which is likely an old reference to the original FOAM 2.x version. Feel free to compare to the old documentation at Nabla: the old Programmer's Guide, section 1.2 Tensors.
Either way, feel free to disregard the 1.x reference, since its objective is reflect that tensors as a mathematical entity, are only partially implemented in OpenFOAM.
1.2 Section 1.4: OpenFOAM tensor classes
1.2.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