Skip to content

README.md

Latest commit

 

History

History
40 lines (29 loc) · 1.3 KB

README.md

File metadata and controls

40 lines (29 loc) · 1.3 KB
Raw

Theseus Documentation

Documentation is a work in progress.

Using Theseus

The top-level README covers dependency installation, building, and quick smoke runs. Simulation behavior is controlled by each test case's config.json input file.

Runtime and input configuration

  • Visualization output: enable visualization, select output fields, and understand the available field names.
  • General input-file reference (coming soon)
  • Checkpoints and restarts: save solution state, validate restart compatibility, and resume a run through the standard helper
  • Axisymmetric formulation: configure swirl-free cylindrical Euler/CNS runs and understand their verification status
  • Verification and CI matrix: integration assertions, smoke cases, golden-data tolerances, and local reproduction commands

Theory

Developer Guide (Coming soon)

  • Architecture
  • Runtime configuration
  • Physics models
  • Adding new components

Verification

See the verification and CI matrix for the maintained test inventory and exact regression tolerances.