FoamNordic documentation¶
Start with installation, then run an existing OpenFOAM case. Continue with the local cavity example before adding field exchange or closures through the tutorials.
FNOM is the portable FoamNordic Model artefact. In benchmark records, OpenFOAM is a direct run, OF/FNO is OpenFOAM launched by Longship without an external field programme, and FNO-coupled includes a closure or transform.
| Area | Use it for |
|---|---|
| Installation | Python environment, OpenFOAM activation, integration build and checks |
| Python API | Declare, execute, export, inspect, and analyse |
| Architecture | Runtime, transport, FNOM, OpenFOAM, and lifecycle contracts |
| Developer guide | Source ownership, extension points, and verification |
| Benchmarks | Numerical parity and performance evidence |
The API documents supported use, architecture documents ownership and implementation, developer documents source changes and verification, and benchmarks preserve measured evidence. Return to the project README.
Reading paths¶
| Goal | Start here | Continue with |
|---|---|---|
| Define and launch a workload | Run control | Numerics, Models and FNOM |
| Export and deploy a model | Models and FNOM | FNOM architecture, Runtime benchmarks |
| Integrate an OpenFOAM solver | OpenFOAM architecture | Lifecycle, Transport |
| Modify an exchange, closure, or backend | Developer guide | Field programmes, Native runtime |
| Inspect stored results | Postprocessing | OpenFOAM validation |
| Install or diagnose the runtime | Installation | Command-line interface |