Installation

Compilation

The compilation requires an active OpenFOAM environment (OpenFOAM, v12).

The location of the cloned repository is not relevant as the location of the binaries is fixed by environment variables from the OpenFOAM environment. However, the general choice for additional OpenFOAM code is whatever $WM_PROJECT_USER_DIR evaluates to. To download and compile, type

cd $WM_PROJECT_USER_DIR #optional
git clone https://github.com/JBuenning/CoMBo-Foam.git && cd CoMBo-Foam/
./Allwmake

Usage inside a simulation

To use any of the functionality provided by CoMBo-Foam in a simulation, its libraries need to be linked explicitely at run-time. This is done by adding the following lines into the case system/controlDict:

libs
(
    "libcombo-foam-motionSolvers.so"
    "libcombo-foam-bc.so"
);

Uninstalling

The easiest way to remove all the compiled code is to delete the $FOAM_USER_LIBBIN directory. This will remove all the user-compiled libraries. If you have other libraries compiled that you want to keep, you have to look inside the folder and select manually.