Welcome to NeoFOAM!

NeoFOAM is the coupling interface between OpenFOAM and NeoN. It provides platform-portable implementations of common CFD algorithms and solvers using NeoN as a computational backend, while leveraging standard OpenFOAM cases so existing simulations can run on accelerator devices.

The documentation is organised by purpose. Pick the quadrant that matches what you’re trying to do:

• Tutorials — step-by-step lessons for newcomers. Start here if you’re new to NeoFOAM.

• How-to guides — focused recipes for one specific task each. Use these when you already know what you’re trying to do.

• Reference — module-by-module API description for the framework packages, generated from docstrings.

• Explanation — the why behind the design: architecture, three-stage initialization, plugin system, operation graph.

Tutorials

• Run your first NeoFOAM case
• Add a passive scalar transport model
• Build a scalar-transport solver from scratch
• Typed configs: YAML, JSON, and OpenFOAM dictionaries

How-to guides

• Install NeoFOAM
• Register a new model
• Add a custom InitStep category
• Work with configuration files
• Visualize the operation DAG
• Inject dependencies into operations

Reference

• neofoam.framework
  • neofoam.framework.context
  • neofoam.framework.operations
  • neofoam.framework.types
  • neofoam.framework.conditions
  • neofoam.framework.decorator
  • neofoam.framework.config_injection
  • neofoam.framework.dependency_resolver
• neofoam.framework.graph
  • neofoam.framework.graph.sorter
  • neofoam.framework.graph.resolver
  • neofoam.framework.graph.validation
  • neofoam.framework.graph.visualization
• neofoam.framework.initialization
  • neofoam.framework.initialization.init_step
  • neofoam.framework.initialization.helpers
  • neofoam.framework.initialization.config_context
  • neofoam.framework.initialization.depends
  • neofoam.framework.initialization.execution
  • neofoam.framework.initialization.staged
• neofoam.framework.model
  • neofoam.framework.model.spec
  • neofoam.framework.model.runtime
• neofoam.framework.solver
  • neofoam.framework.solver.spec
  • neofoam.framework.solver.runtime

Explanation

• Goals & core concepts
• Solver structure
• Model structure
• Spec and Runtime
• Three-stage initialization
• Operations and the DAG
• Parameter injection
• The discriminated-union plugin registry
• Model discovery: plugin vs core spec
• Schema introspection

Project

• Continuous Integration
• Using Kokkos Tools

Indices and tables

• Index

• Module Index

• Search Page