Browse Source Code

The best source of information is the source code and the Doxygen documentation.

Source code

The source code of the solver (executable, not library) and governing equations solved are described following the source code located in the directory $FOAM_SOLVERS

Looking at the directory as example:

tree /opt/OpenFOAM/OpenFOAM-v2206/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam

It will return the source code that builds the equation of your solver

.
├── buoyantBoussinesqSimpleFoam.C
├── createFields.H
├── Make
│   ├── files
│   └── options
├── pEqn.H
├── readTransportProperties.H
├── TEqn.H
└── UEqn.H

Other sources can be searched around. I.g: To find where the source code for the boundary condition “slip” is located:

find $FOAM_SRC -name "*slip*"

Contoruring slip with * will make find able to find the word even inside a more complex title

Doxigen

The directory $WM_PROJECT_DIR/doc contains the Doxygen documentation of OpenFoam®. Before using the Doxygen documentation, you will need to compile it. To compile the Doxygen documentation, from the terminal:

cd $WM_PROJECT_DIR
./Allwmake doc

Note: You will need to install doxygen and graphviz/dot.

After compiling the Doxygen documentation, you can use it by typing:

firefox file://$WM_PROJECT_DIR/doc/Doxygen/html/index.html

As a notice we say that the compilation is time consuming.