Skip to content

Solver Reference

The GUI docs site does not re-own the solver's API documentation.

The companion solver lives in ../cfd-solver, and that repository is the source of truth for:

  • FORD-generated solver API/reference docs
  • Numerical-method and theory documentation
  • Solver-side namelist validation and scheme dispatch behavior

Coupling Surfaces To Keep In Mind

  • Namelist keys and valid values
  • Scheme names passed through the GUI
  • The solver CLI contract
  • result.dat and snapshot.dat file formats

When you change one of those surfaces in this repo, inspect the corresponding solver code and docs before you finalize the change. The GUI is a separate application, but these boundaries are shared contracts.