Documentation of the main branch

These pages follow Mallard's main branch, which is ahead of release 0.8.0: some features they describe come with the next release.

Documentation

Mallard is a high-order finite volume solver for compressible, viscous and reacting flows on unstructured meshes, on CPUs and GPUs. Start with a build and a first run, then find each topic in the user guide; every input key is in the reference.

• Getting started

  ---

  • Installation: CMake builds for CPUs, NVIDIA and AMD GPUs, MPI
  • First simulation: the Sod shock tube in ten minutes
  • Input files: how an input is organized

• User guide

  ---

  Meshes · Physics · Thermochemistry · Large-eddy simulation · Numerics · Boundary conditions · Sources and sponges · Initialization and restarts · Output and diagnostics · Running in parallel · Performance

• Reference

  ---

  • Input reference: every key and its default
  • Theory manual: the equations and methods, as implemented
  • Numerical methods and TENO-E details
  • Tools, references, API reference

• Examples and validation

  ---

  • Examples: 40 cases by topic, with their cost
  • Validation: each case against its reference
  • Gallery: the largest runs