The purpose of this repository is to simplify and showcase how NeoFOAM can be used in combination with OpenFOAM. It provides converters between OpenFOAM and NeoFOAM datastructures, examples and tests.
FoamAdapter has the following requirements
- cmake 3.22+
- gcc >= 12 or clang >= 18+
- OpenFOAM 2406
- CUDA 12.1 (for GPU support)
This repository depends on NeoFOAM which is included as a Git submodule, you can clone this repository and execute the following command to initialise the submodule.
git submodule update --init --recursive
We provide several Cmake presets to set commmonly required flags if you compile FoamAdapter
cmake --list-presets # To list existing presets
cmake --preset production # To compile for production use
The repository is structured in the following way:
- src and include implement common functionality to copy data between OpenFOAM and NeoFOAM
- tests demonstrating that NeoFOAM and OpenFOAM deliver identical results are provided by this repository in the test folder.
- examples provides examples which can be run like typical OpenFOAM cases