OpenFOAM® v1.6 Documentation

OpenFOAM®  v1.6 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. It is available in: HTML format here.

C++ Source Guide

The C++ Source Guide, generated by Doxygen is supplied in the doc directory of the OpenFOAM release but can also be accessed by clicking here. The documentation has links to source code, inheritance and collaboration diagrams, and more. The search facility in the online version is activated.

-->

Release Notes

Useful information on new features of and hints for upgrading to version 1.6 can be found in Release Notes.

README file

There is also a README file in the OpenFOAM installation directory that can also be accessed online here.

Upgrade notes

Notes on upgrading from previous to the latest version of OpenFOAM can be found here. These notes are maintained and will be added to from time to time.

Other documentation

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.

Programmer’s Guide (discontinued)

The Programmer’s Guide is a misnomer. It contains some information about tensors, their linear and differential algebra, finite volume discretisation, and more. It is very out of date and can be found in the doc directory of the OpenFOAM release and online here. -->