Skip to content

Getting started

Getting started

Tutorials

Run your first model
Write a model with ready-made bricks
Write a model with the physics DSL
Build a HyQMOM15 moment model
Combine native bricks and authored physics
Run the Euler-Poisson case
Run the Hoffart diocotron case
Self-gravitating Euler-Poisson
Run the asymptotic-preserving two-fluid case

Concepts

Hyperbolic-elliptic systems
The typed authoring API
PhysicalModel
Conservative and primitive variables
Fluxes, sources and eigenvalues
Moment models and closures
Elliptic right-hand side and the aux channel
Poisson equation
Time integration
Operator splitting, IMEX and Schur condensation
Adaptive mesh refinement
Multi-block and multi-species systems
Polar and disc geometry

How-to guides

Add a new model
Add or use a native brick
Add a DSL model
Add a numerical flux
Add a new case
Define initial conditions
Configure outputs and diagnostics
Visualize with ParaView
Run with OpenMP
Run with MPI
Run with Kokkos
Run on GH200
Profile performance

Writing a model

Models

Simulation

Simulation

AMR

AMR

Running

Running

Advanced topics

Advanced topics

Reference

Reference

Development

Development

Design

Design
- Spec 4: Python package architecture

C++ reference

Embedded C++ API
- Namespaces
  - Namespace List
  - Namespace Members
    - All
      - a
      - b
      - c
      - d
      - e
      - f
      - g
      - h
      - i
      - j
      - k
      - l
      - m
      - n
      - o
      - p
      - r
      - s
      - t
      - u
      - v
      - w
      - x
      - y
      - z
    - Functions
      - a
      - b
      - c
      - d
      - e
      - f
      - g
      - h
      - i
      - j
      - k
      - l
      - m
      - n
      - o
      - p
      - r
      - s
      - t
      - u
      - v
      - w
      - x
      - y
      - z
    - Variables
    - Typedefs
    - Enumerations
- Concepts
- Classes
  - Class List
  - Class Index
  - Class Hierarchy
  - Class Members
    - All
      - a
      - b
      - c
      - d
      - e
      - f
      - g
      - h
      - i
      - j
      - k
      - l
      - m
      - n
      - o
      - p
      - q
      - r
      - s
      - t
      - u
      - v
      - w
      - x
      - y
      - z
      - ~
    - Functions
      - a
      - b
      - c
      - d
      - e
      - f
      - g
      - h
      - i
      - l
      - m
      - n
      - o
      - p
      - q
      - r
      - s
      - t
      - u
      - v
      - w
      - x
      - y
      - ~
    - Variables
      - a
      - b
      - c
      - d
      - e
      - f
      - g
      - h
      - i
      - j
      - k
      - l
      - m
      - n
      - o
      - p
      - q
      - r
      - s
      - t
      - u
      - v
      - w
      - x
      - y
      - z
    - Typedefs
    - Enumerations
- Files
  - File List
  - File Members
    - All
    - Macros
C++ API (Doxygen)

Running¶

This section covers how to build and run adc_cpp on each supported backend.

Overview
Backend seams
CMake options
Kokkos Serial
Kokkos OpenMP
MPI + Kokkos Serial
MPI + Kokkos OpenMP
Kokkos CUDA on GH200
MPI + Kokkos CUDA
Backend matrix

AMR compatibility contract

Copyright © 2026, Romain Despoullains

Made with Sphinx and @pradyunsg's Furo