Installation
Linux instructions
You need first a working OpenFOAM installation on you computer.
Then, load the OpenFOAM environment, i.e. for example
source /opt/OpenFOAM-v2406/etc/bashrc
Then in the “porousMultiphaseFoam” directory, run
./Allwmake -j
to install the package (-j allow the parallel compilation).
The PMF dynamic libraries are compiled and stored in the standard OpenFOAM user directory
$FOAM_USER_LIBBIN
while the executable solvers are placed in the standard OpenFOAM user directory
$FOAM_USER_APPBIN.
Each tutorial directory contains “run” and “clean” files to test installation and validate the solver.
A python script runTutorials.py can be used to test all components.
To remove compilation and temporary files, run
./Allwclean --purge
–purge is optional and force the deletion of the executables and libraries.
see the ReleaseNotes.txt file for detailed information about the toolbox.
Windows instructions
Download the Windows Native version of OpenFOAM v2406, compiled with MinGW:
https://sourceforge.net/projects/openfoam/files/v2406/OpenFOAM-v2406-windows-mingw.exe/download
Install in a folder (e.g., D:OpenFOAMv2406)
Go to D:OpenFOAMv2406thirdParty and install the required dependency (MPI) using msmpisetup.exe
Open the OpenFOAM terminal (MSYS2)
Create the user directory in the OpenFOAM installation using the command:
mkdir -p $FOAM_USER_APPBIN
Download the latest Windows-compiled version of PMF:
Unzip the file and copy all files from the bin/ and lib/ folders to:
D:OpenFOAMv2406msys64homeofuserOpenFOAMUSER-v2406platformswin64MingwDPInt32Optbin
Note: Replace “USER” with your actual username)
Note: DLL and EXE files must be placed directly in the folder (do not preserve the PMF file directory structure)
The PMF executables should be accessible from the OpenFOAM terminal. Try to run groundwaterFoam.exe
Compatibility
Depending on your installation, you should switch to the github branch corresponding to your OpenFOAM version. If you use OpenFOAM-v2406 for example:
git checkout openfoam-v2406
Note that if you want to use the latest version of PMF, it is necessary to have a sufficiently recent installation of openfoam.
OpenFOAM-v11 and OpenFOAM-v12 are not supported currently, use OpenFOAM.com versions.
Development branches
branch dev works with OpenFOAM-v2406 openfoam.com
Updated branches: PMFv2406.0
branch openfoam-v2406
branch openfoam-v2306
branch openfoam-v2206
branch openfoam-v2106
openfoam-v10 has errors when using postProcess/setSet in tutorials
Note that intermediate version (i.e. v1912, v2012v, v2112…) are not tested.
Old branches not updated
branch openfoam-v10 > PMFv2310
branch openfoam-v9 > PMFv2310
branch foam-extend-4.0 > PMFv1809
Version not supported
OpenFOAM 8 and older
foam-extend 3.2 and older
OpenFOAM v2006 and older