OpenFOAM® Documentation

OpenFOAM®  Documentation

User Guide

The documentation consists firstly of a User Guide that contains information about the general running of OpenFOAM, I/O data structures, compilation, applications, libraries, mesh generation, post-processing and more.

The User Guide is currently maintained by CFD Direct on behalf of the OpenFOAM Foundation. CFD Direct maintain an HTML version of the OpenFOAM User Guide that is mobile friendly (see below).

The User Guide can be obtained in the following ways:

Quick Links to Pages in the User Guide:
OpenFOAM Tutorials : cavityplateHoledamBreak
OpenFOAM Applications : C++CompilingRunningRunning in ParallelSolversUtilitiesLibraries
OpenFOAM Cases : File StructureFile FormatcontrolDictfvSchemesfvSolution
OpenFOAM Meshes : DescriptionBoundariesblockMeshsnappyHexMeshConversionmapFields
OpenFOAM Post-Processing : ParaviewFluentFieldviewEnsightSampleJob Handling
OpenFOAM Modelling : ThermophysicalTurbulenceTransport/Rheology

The PDF version of the User Guide, English PDF is also supplied in the doc directory of the OpenFOAM distribution.

C++ Source Guide

The C++ Source Guide, generated by Doxygen has links to source code, inheritance and collaboration diagrams, and more.
The C++ source guide can be generated within the OpenFOAM installation by simply executing “doxygen” from within the doc directory of the OpenFOAM distribution.
Click C++ Source Guide (HTML) to access the generated source documentation on this site.

Other Documentation

A collection of OpenFOAM Documentation is available that includes:

OpenFOAM is open source. The source code of OpenFOAM is a vital source of documentation in itself. As well as the actual code itself, most applications, for example, contain descriptions of what they do, there are descriptions of various models with supporting references, etc..

The use of most applications can be learnt by looking at the corresponding example case in the $FOAM_TUTORIALS directory in the OpenFOAM release. The Allrun scripts show how many applications are executed.