6th March 2013

OpenFOAM 2.2.0: Documentation

In the latest release we have introduced enhanced documentation of OpenFOAM within the HTML source documentation generated using Doxygen. The new feature uses extended file headers in which documentation is written and processed into pages by Doxygen.

Access to Doxygen Modules

Doxygen modules provide a convenient interface to grouped information, accessible via the Modules tab located in the main header. Currently, grouped information is available for boundary conditions, function objects and turbulence models. Each group item is a link to the contents of the respective groups.

Boundary Condition Documentation

Extended documentation has been written for boundary conditions and function objects. An example of the documentation for the turbulentInlet BC is shown below

turbulentInletDoc

The helper utility, foamHelp, allows the user to bring up documentation from a terminal prompt. The usage is shown below. A high-level view of boundary condition help can also be accessed from the main Doxgen page, from the Using the code section.

foamHelp boundary:

Command line usage:

Usage: foamHelp [OPTIONS] 
options:
   -browse     display documentation for boundary condition in browser
   -constraint       list constraint patches
   -field      list available conditions for field
   -fixedValue       list fixed value patches (use with -field option)

- with no additional options, lists all known boundary conditions

- list all boundary conditions for a given field, e.g.
    foamHelp boundary -field p

- redirect to Doxygen documentation using, e.g.:
    foamHelp boundary -browse fluxCorrectedVelocity

Function Object Documentation

foamHelp also brings up documentation for function objects, with usage shown below. A high-level view of function object help can also be accessed from the main Doxgen page, from the Using the code section.

foamHelp functionObject

Command line usage:

Usage: foamHelp [OPTIONS] 
options:
   -browse     display documentation for boundary condition in browser

- with no additional options, lists all known function objects

- redirect to Doxygen documentation using, e.g.:
     foamHelp functionObject -browse forces