Finite-difference solver for the 1D Euler equations with canonical manual docs in doc/*.org and API docs generated by FORD.

cfd-solver

cfd-solver

Finite-difference solver for the one-dimensional Euler equations, implemented as an fpm library, shared-library ABI, and executable.

The canonical manual docs live in doc/developer-guide.org and doc/theory-guide.org. This FORD site is intentionally a light API and dependency-graph layer generated from source docstrings.

Documentation Roles

  • doc/developer-guide.org — authoritative manual for build/run workflows, platform support, configuration, examples, architecture, profiling, and operational behavior.
  • doc/theory-guide.org — authoritative manual for equations, derivations, and algorithmic background.
  • README.md — landing page and quick-start summary only.

Scope

The library supports configurable numerical schemes, multiple boundary conditions, built-in and external initial-condition workflows, checkpoint / restart, logging, profiling hooks, a polling-friendly session API, and a C ABI declared in include/cfd_solver.h. See the developer guide for the current public option names, defaults, and adapter/build workflow.

Developer Info

Haiyu Wang