Welcome to NeoN!

The NeoN project has set itself the goal of bringing modern software development methods to the core libraries of OpenFOAM. By reimplementing the libfiniteVolume and libOpenFOAM we want to deliver a code that:

• is compliant with modern C++20;

• is extensively unit-tested;

• is platform portable and GPU ready;

• is highly extensible via Plugins

We aim for a high level of interoperability with OpenFOAM, however, if reasonable, NeoN might deviate from the OpenFOAM API. NeoN is a community-driven project and we welcome contributions from everyone.

Table of Contents

• Welcome to NeoN!
• Installation
  • Building with CMake Presets
  • Building with Spack
  • Prerequisites
  • Workflow with vscode
• Contributing
  • NeoN Code Style Guide
  • Collaboration via Pull Requests
  • Github Workflows and Labels
  • Building the Documentation
• Basics
  • Executor
  • Vectors
  • Parallel Algorithms
  • Derived class discovery at compile time
  • Macro Definitions
• Domain Specific Language (DSL)
  • Expression
  • Operator
• Time Integration
  • Forward Euler
  • Runge Kutta
• FiniteVolume
  • Boundary Conditions
  • Case Study: The Gauss Green Div Kernel
• Datastructures
  • UnstructuredMesh
  • Dictionary
  • Database
• MPI Architecture
  • Background
  • Communication
  • Partitioning
  • Future Work

Compatibility with OpenFOAM

We are aiming for a high level of compatibility with OpenFOAM. However, we don’t expect binary or ABI compatibility. This means that NeoN won’t produce a libfiniteVolume.so and libOpenFOAM.so which could serve as a plugin replacement for existing libfiniteVolume.so and libOpenFOAM.so. Instead, we aim for source compatibility, i.e. the possibility to compile application OpenFOAM code like pimpleFoam and others against the NeoN libraries. This approach is demonstrated in the FoamAdapter repository.

Indices and tables

• Index

• Module Index

• Search Page