Difference between revisions of "OpenFOAM guide/Programmer's Guide Errata"
From OpenFOAMWiki
(Added errata for Table 1.2 at 1.4.1 Algebraic tensor operations in OpenFOAM) |
(Added the suggestions made for 2.4.6 and 2.6.1) |
||
| Line 6: | Line 6: | ||
| − | == Section 1.4 OpenFOAM tensor classes == | + | == Section 1.4: OpenFOAM tensor classes == |
| − | === Subsection 1.4.1 Algebraic tensor operations in OpenFOAM === | + | === Subsection 1.4.1: Algebraic tensor operations in OpenFOAM === |
{{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} | ||
| Line 25: | Line 25: | ||
= Chapter 2: Discretisation procedures = | = Chapter 2: Discretisation procedures = | ||
| + | |||
| + | == Section 2.4: Equation discretisation == | ||
| + | |||
| + | |||
| + | === Subsection 2.4.6: Gradient === | ||
| + | |||
| + | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} | ||
| + | |||
| + | * All references to '''timeScheme''' should be either ''gradSchemes'' or ''snGradSchemes'' [http://www.cfd-online.com/Forums/openfoam-bugs/82225-programmers-guide-p-40-a.html]. | ||
| + | * The indication of '''[Check**]''' implies that this subsection needs to be revised. | ||
| + | |||
| + | |||
| + | === Subsection 2.6.1: Physical boundary conditions === | ||
| + | |||
| + | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} | ||
| + | |||
| + | * The indication of '''[Check**]''' implies that this subsection needs to be revised. | ||
| + | |||
| Line 39: | Line 57: | ||
* [http://www.cfd-online.com/Forums/openfoam-bugs/104867-bug-programmers-guide-divergence-tensor-field.html Bug in the programmer's guide: divergence of a tensor field] | * [http://www.cfd-online.com/Forums/openfoam-bugs/104867-bug-programmers-guide-divergence-tensor-field.html Bug in the programmer's guide: divergence of a tensor field] | ||
* [http://www.cfd-online.com/Forums/openfoam-bugs/82225-programmers-guide-p-40-a.html In Programmer's Guide p. 40] | * [http://www.cfd-online.com/Forums/openfoam-bugs/82225-programmers-guide-p-40-a.html In Programmer's Guide p. 40] | ||
| + | ** The issues in post #1 are at [[#Subsection 2.4.6: Gradient|Subsection 2.4.6: Gradient]] and [[#Subsection 2.6.1: Physical boundary conditions|Subsection 2.6.1: Physical boundary conditions]] | ||
* [http://www.cfd-online.com/Forums/openfoam-bugs/73361-programmers-guide-bugs.html Programmers Guide Bugs] | * [http://www.cfd-online.com/Forums/openfoam-bugs/73361-programmers-guide-bugs.html 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|1.4.1 Algebraic tensor operations in OpenFOAM]]. | + | ** The issues indicated in post #1 are already here in the wiki in the subsection [[#Subsection 1.4.1 Algebraic tensor operations in OpenFOAM|Subsection 1.4.1 Algebraic tensor operations in OpenFOAM]]. |
* [http://www.cfd-online.com/Forums/openfoam-bugs/62533-error-documentation.html Error in documentation] | * [http://www.cfd-online.com/Forums/openfoam-bugs/62533-error-documentation.html Error in documentation] | ||
[[Category:OpenFOAM guide]] | [[Category:OpenFOAM guide]] | ||
Revision as of 09:37, 7 September 2013
Community created Errata for the OpenFOAM Programmer's Guide.
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
Valid versions: 
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.4: Equation discretisation
2.1.1 Subsection 2.4.6: Gradient
Valid versions:
- All references to timeScheme should be either gradSchemes or snGradSchemes [1].
- The indication of [Check**] implies that this subsection needs to be revised.
2.1.2 Subsection 2.6.1: Physical boundary conditions
Valid versions:
- 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 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
- 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
