Skip to main content

Crate outram_foam_appbuilder_lib

Crate outram_foam_appbuilder_lib 

Source
Expand description

This is OUTRAM PARK’s independent Rust translation of selected OpenFOAM® solver-application algorithms — it is not the official OpenFOAM® software and is not affiliated with, endorsed by, or sanctioned by OpenCFD Ltd. or the ESI Group. OpenFOAM® is a registered trademark of OpenCFD Limited. See TRADEMARKS.md (this crate’s directory, mirrored from the workspace root) for the full attribution and non-affiliation notice.

§outram-foam-appbuilder-lib — Layer 5: solver applications and case I/O

This crate is the application layer of the OUTRAM PARK OpenFOAM-in-Rust stack. It sits on top of outram-foam-basic-lib (Layers 1–4: tensors, fields, mesh, fvm/fvc operators, linear solvers) and outram-foam-turbulence-lib (turbulence closures), and supplies the parts those crates deliberately do not: the time-advancement loops, the case-file structures, and the multiphysics coupling drivers.

outram-foam-basic-lib        Layers 1–4  primitives, fields, mesh, FV operators
outram-foam-turbulence-lib   Layer 4     RAS/LES closures
           │
           ▼
outram-foam-appbuilder-lib   Layer 5     ← THIS CRATE

§Where to start

  • solvers — one submodule per ported OpenFOAM application. Each owns its PISO/PIMPLE (or explicit) time loop. Construct one with new(mesh, control, schemes, solution), set the field state, then call step() or run().
  • case_runner — the layer above that: read an OpenFOAM case directory, build the solver’s initial state from it, march the loop and write the fields back. CaseRun::from_case(dir, SolverKind::PimpleFoam) is the one-line way in; the CLI binaries in outram-foam-cli are thin wrappers over it, and it is what the Python bindings expose.
  • io — readers for constant/polyMesh and 0/<field> files, plus typed controlDict / fvSchemes / fvSolution structs.
  • turbulence — pick a closure for a solver run.
  • prelude — one use that pulls in the commonly needed public items.
  • tutorials/ — runnable end-to-end cases; the intended entry point for a reader new to the crate.

§Maturity — read before depending on this

This is an early (0.1.0), in-progress crate and its surface is uneven: some paths are validated against published benchmarks, others are unexercised, and several are todo!(). The README.md “Limitations” section is the authoritative per-module status and is deliberately detailed. Two consequences bite immediately:

Per the workspace RESPONSIBLE_USE.md, nothing here is for reactor operation, control, licensing, or any safety-critical or operational use.

Modules§

case_runner
The crate’s single error type, error::AppBuilderError. Driving a solver from an OpenFOAM case directory: read the case, build the solver’s initial state, march the time loop, write the fields back.
cases
Ready-made flow cases (boundary conditions + diagnostics) shared by V&V tests and demos, e.g. cases::laminar_pipe. Ready-made cases: the boundary conditions, solver settings and diagnostics of a named flow, shared by V&V tests and demos.
error
error — the crate’s single error type
genfoam
GeN-Foam reactor-multiphysics port (neutronics + TH + thermo-mechanics). See docs/genfoam-port-plan.md for the module map and translation order.
htgr_closures
Pebble-bed HTGR closures (original work, not a GeN-Foam port): bed effective conductivity (Breitbach default, ZBS comparison), KTA 3102.2 heat transfer, KTA 3102.3 pressure drop, and the IAEA-TECDOC-1694 HTR-10 solid conductivities. See htgr_closures.
htr10_rz
The HTR-10 R-Z solid conduction and radiation model (original work, gh:#1149 part B): the TECDOC-1694 44-region THERMIX-style model built from the cited input sheet on the solid conduction field, with the htgr_closures properties. See htr10_rz.
io
OpenFOAM case input/output — polyMesh and field readers, typed controlDict/fvSchemes/fvSolution, and (unimplemented) field writers.
prelude
Re-exports of the crate’s commonly used public items, for use outram_foam_appbuilder_lib::prelude::*;.
solvers
The ported OpenFOAM solver applications and their time-advancement loops.
turbulence
Turbulence-closure selection for the solver loops — the Layer-5 adapter over outram-foam-turbulence-lib. See turbulence::TurbulenceClosure.