Requirements | Compilation | Integration | Documentation | Roadmap |
Important
The NeoFOAM project needs you! If you're interested in contributing to NeoFOAM please open a PR! If you have any questions on where to start please contact us here or on gitter.
NeoFOAM has the following requirements
- cmake > 3.22
- gcc >= 10 or clang >= 16
- Kokkos 4.3.0
For NVIDIA GPU support
- cuda 12+
For development it is required to use pre-commit.
C++ dependencies like Kokkos are handled via CPM and are cloned at the configuration step.
However, the cmake build process will prefer system wide installed C++ dependencies like Kokkos, cxxopts, etc.
If you prefer to clone, configure and build dependencies your self consider setting -DCPM_USE_LOCAL_PACKAGES = OFF, see CPM for more details.
NeoFOAM uses cmake to build, thus the standard cmake procedure should work. From a build directory you can execute
cmake <DesiredBuildFlags> ..
cmake --build .
cmake --install .
Additionally, we provide several Cmake presets to set commmonly required flags if you compile NeoFoam in combination with Kokkos.
cmake --list-presets # To list existing presets
cmake --preset production # To configure for production use
cmake --build --preset production # To compile for production use
We provide a set of unit tests which can be execute via ctest or
cmake --build . --target test
Currently, NeoFOAM is not a standalone CFD Framework. It is designed to be used within OpenFOAM. Examples how to integrate NeoFOAM into OpenFOAM and howto write applications is demonstrated in the FoamAdapter repository.
An online documentation can be found here, be cautious since this repository is currently evolving the documentation might not always reflect the latest stage. For building the documentation further dependencies like doxygen and sphinx are requirement. The list of requirements can be found here