Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
NeoFOAM documentation
NeoFOAM documentation

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.execution.init_result
      • neofoam.framework.initialization.execution.validation
      • neofoam.framework.initialization.execution.ordering
      • neofoam.framework.initialization.execution.executor
      • neofoam.framework.initialization.execution.context_builder
    • neofoam.framework.initialization.staged
      • neofoam.framework.initialization.staged.spec
      • neofoam.framework.initialization.staged.runner
  • 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
Back to top
View this page

neofoam.frameworkΒΆ

Root-level modules of the framework package. Sub-packages (graph, initialization, model, solver) are documented under their own entries in the Reference section.

  • neofoam.framework.context
  • neofoam.framework.operations
  • neofoam.framework.types
  • neofoam.framework.conditions
  • neofoam.framework.decorator
  • neofoam.framework.config_injection
  • neofoam.framework.dependency_resolver
Next
neofoam.framework.context
Previous
Inject dependencies into operations
Copyright © 2025, NeoFOAM authors
Made with Sphinx and @pradyunsg's Furo