API overview

This is a detailed overview of Aragog's API for the user's reference. If you want to understand the underlying model, please visit the model overview.

Directory structure

aragog
├── cfg
│   ├── abe_liquid.cfg
│   ├── abe_mixed.cfg
│   ├── abe_mixed_init.cfg
│   ├── abe_mixed_lookup.cfg
│   ├── abe_solid.cfg
│   └── __init__.py
├── cli.py
├── core.py
├── data.py
├── __init__.py
├── interfaces.py
├── mesh.py
├── output.py
├── parser.py
├── phase.py
├── solver.py
└── utilities.py

Here, the cfg subdirectory contains config files used as input for Aragog, that can be adjusted or added to.

High-level architecture

Aragog is structured around a small number of components:

1. Configuration and scaling (parser.py)
2. Mesh and equation-of-state (EOS) setup (mesh.py)
3. Phase/property evaluators (phase.py, interfaces.py)
4. State evaluation (fluxes, heating) (solver.py)
5. Time integration (solver.py → scipy.integrate.solve_ivp)
6. Postprocessing and export (output.py)