Difference between revisions of "OpenFOAM guide/Programmer's Guide Errata"
From OpenFOAMWiki
(Added link for the official Programmer's Guide, as well as adding the links for the threads I could find.) |
(Added errata for Table 1.2 at 1.4.1 Algebraic tensor operations in OpenFOAM) |
||
| Line 3: | Line 3: | ||
Notes to contributors: Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers) | Notes to contributors: Please include the chapter number of the printed version to avoid confusion (the Wiki might give different chapter numbers) | ||
| − | + | = Chapter 1: Tensor mathematics = | |
| − | == | + | == Section 1.4 OpenFOAM tensor classes == |
| − | |||
| + | === Subsection 1.4.1 Algebraic tensor operations in OpenFOAM === | ||
| + | {{versionInfo}}{{Version1.6}}{{Version1.7}}{{Version2.0}}{{Version2.1}}{{Version2.2}} | ||
| − | + | In ''Table 1.2: Algebraic tensor operations in OpenFOAM'', the following entries need fixing: | |
| + | {| border="1" cellpadding="2" | ||
| + | ! Operation !! Description in OpenFOAM<br>''(wrong)'' !! Description in OpenFOAM<br>''(correct)'' | ||
| + | |- | ||
| + | | Component maximum || max(a) || cmptMax(a) | ||
| + | |- | ||
| + | | Component minimum || min(a) || cmptMin(a) | ||
| + | |- | ||
| + | | Scale || scale(a,b) || cmptMultiply(a,b) | ||
| + | |} | ||
| − | == Known threads on this topic | + | = Chapter 2: Discretisation procedures = |
| + | |||
| + | |||
| + | = Chapter 3: Examples of the use of OpenFOAM = | ||
| + | |||
| + | |||
| + | = Chapter 4: Programming techniques = | ||
| + | |||
| + | |||
| + | <br> | ||
| + | = 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: | 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: | ||
| Line 20: | Line 40: | ||
* [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] | ||
* [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]]. | ||
* [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:26, 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
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
- Programmers Guide Bugs
- The issues indicated in post #1 are already here in the wiki in the subsection 1.4.1 Algebraic tensor operations in OpenFOAM.
- Error in documentation
