AGILE

This is the API reference for AGILE, generated by FORD from the Doxygen-style !>/!< comments in the Fortran source under src/.

AGILE's hd/mhd/ffhd/srhd physics modules are mutually-exclusive fypp (#:if PHYS == '...') branches, so a single fypp pass with one PHYS value only shows that physics module's variant of any file whose content depends on it. To cover all four physics modules, every file is preprocessed once per physics module (doc/ford/docgen_{mhd,hd,ffhd,srhd}.par); files that turn out identical across all four (the vast majority -- anything with no PHYS-dependent content) are kept once under their real name, while files that differ are kept once per physics module with the module renamed with a _hd/_mhd/_ffhd/_srhd suffix (e.g. mod_physics_hd) so all variants can coexist in this site without name collisions. Which files need suffixing is discovered automatically by comparison, not hand-maintained. Suffixed module names are a documentation-only convenience -- they don't exist in the compiled code; the real, single mod_physics module (etc.) compiles to whichever PHYS was selected at actual build time. See doc/ford/build_docs.sh and doc/ford/merge_physics_variants.py for details.

Narrative documentation (installation, getting started, parameter list, etc.) is folded into this site from the plain markdown files in doc/ (FORD's page_dir, required to have doc/index.md) -- see the doc pages.