API Reference
using Pyrolysis exposes a deliberately curated top-level surface — the types and functions needed to define materials, set boundary conditions, build problems, solve them, and post-process results. Everything else is reachable as Pyrolysis.<Submodule>.name or through the Pyrolysis.Internal umbrella module, and research-grade functionality lives in Pyrolysis.Experimental.
The User Guide's API and parameter reference chapter complements these docstring pages with default-value tables and an import cheat-sheet.
Pages
| Page | Covers |
|---|---|
| Materials | Material, components, phases, mixing rules |
| Property functions | The seven property-function types |
| Reactions | Reaction, ReactionSet, depletion limiting |
| Boundary conditions | Thermal, mass, and pressure BCs; BoundaryConditionSet |
| Radiation | RadiationModel selection |
| Geometry | Mesh creation and mesh types |
| Problem | PyrolysisProblem, PyrolysisSolution |
| Solving | solve and parameter_sweep |
| Residual layer | ProblemDef/Workspace, residual!, state accessors |
| Jacobian | Backends, linear-solve strategies, verification |
| Sensitivity | Forward/adjoint sensitivity entry points |
| Diagnostics | Conservation trackers and reports |
| Adaptivity | Error indicators, monitors, mesh operations |
| Experimental | P1 radiation, h-AMR |
| Extensions | Optional-dependency extensions and their hooks |
| Internals | The Internal umbrella and common internal helpers |