Logo

Introduction

  • About
    • Key Features of the dream Solver
    • Work in progress
  • Installation
  • Funding
  • Contribute
  • Structure
    • Solvers
    • Two-level time structure
    • Finite element methods
    • Solution routines
  • References
    • Publications
    • Literature

Solvers

  • scalar_transport
    • Solver Architecture
    • Scalar Transport Equation
    • Discretisation
      • Hybridised Discontinuous Galerkin (HDG)
      • Discontinuous Galerkin (DG)
      • Riemann Solver
    • Boundary and Initial Conditions
    • Time Integration
    • API Reference
      • solver
        • ScalarTransportSolver
      • spatial
        • DG
        • HDG
        • ScalarTransportFiniteElementMethod
      • time
        • explicit
        • imex
        • implicit
      • riemann_solver
        • LaxFriedrich
        • RiemannSolver
      • config
        • FarField
        • transportfields
    • Examples
      • Quick Start: Scalar Transport
      • Scalar wave equation in 1D
      • Rotation of a Gaussian hill
  • compressible_flow
    • Solver Architecture
    • Compressible flow equations
    • Quasi-linear Euler equations
    • Flow Configuration
      • Equation of State
      • Viscosity
      • Non-Dimensionalisation Scaling
      • Riemann Solver
    • Discretisation
    • Boundary Conditions
    • Initial and Domain Conditions
    • Time Integration
    • API Reference
      • solver
        • CompressibleFlowSolver
      • conservative
        • dg
        • diffusion
        • hdg
        • time
      • eos
        • EquationOfState
        • IdealGas
      • riemann_solver
        • HLL
        • HLLEM
        • LaxFriedrich
        • RiemannSolver
        • Roe
        • Upwind
      • viscosity
        • Constant
        • DynamicViscosity
        • Inviscid
        • Sutherland
      • scaling
        • Acoustic
        • Aeroacoustic
        • Aerodynamic
        • Scaling
      • config
        • AdiabaticWall
        • CBC
        • CompressibleFiniteElementMethod
        • ConservativeFiniteElementMethod
        • Dirichlet
        • FarField
        • Force
        • GRCBC
        • Inflow
        • InterfaceBC
        • InviscidWall
        • IsothermalWall
        • NSCBC
        • Outflow
        • PML
        • Symmetry
        • dimensionalfields
        • flowfields
    • Examples
      • Quick Start: Compressible Flow
      • Flow around NACA 0012 airfoil
      • Isentropic Vortex in 2D
      • IMEX: Isentropic Vortex on a Geometry-Split Mesh
        • Mesh
        • Shared Configuration
        • Implicit Solver (HDG, sdirk33)
        • Explicit Solver (DG, rk_ars33)
        • Initial Condition: Isentropic Vortex
        • Boundary and Initial Conditions
        • Initialise, Link, and Solve
      • Planar Acoustic Pulse: Reflecting vs Non-Reflecting Boundaries
        • Domain and Mesh
        • Physical Setup
        • Simulation Loop
        • Results

Time Integration

  • Time Integration
    • Stationary and transient routines
    • Geometry-split implicit-explicit (IMEX) time integration
    • Timer
      • Timer.interval
      • Timer.step
      • Timer.t
    • Scheme
      • Scheme.compile
      • Scheme.parse_sum_of_integrals()
    • TimeSchemes
      • TimeSchemes.update_final_stage_solution()
    • TimeRoutine
      • TimeRoutine.parse_routine_log()
    • StationaryRoutine
    • TransientRoutine
      • TransientRoutine.timer
    • PseudoTimeSteppingRoutine
      • PseudoTimeSteppingRoutine.timer
      • PseudoTimeSteppingRoutine.max_time_step
      • PseudoTimeSteppingRoutine.increment_at
      • PseudoTimeSteppingRoutine.increment_factor
    • IMEXTimeRoutine
      • IMEXTimeRoutine.gtimer
      • IMEXTimeRoutine.ltimer
      • IMEXTimeRoutine.gscheme
      • IMEXTimeRoutine.lscheme
      • IMEXTimeRoutine.update_final_stage_solution()
    • SynchronizedIMEXTimeRoutine
      • SynchronizedIMEXTimeRoutine.update_final_stage_solution()
    • PCIMEXTimeRoutine
      • PCIMEXTimeRoutine.update_final_stage_solution()
    • LinearPCIMEXTimeRoutine

Mesh

  • mesh
    • Predefined mesh generators
    • Structured mesh generators
    • Buffer and sponge layer infrastructure
    • Condition containers
    • get_nodal_points()
    • get_cylinder_mesh()
    • get_cylinder_omesh()
    • get_rectangular_mesh()
    • get_structured_cylinder_mesh()
    • get_2d_naca_occ_profile()
    • get_3d_naca_occ_profile()
    • get_chord_naca_4digit_series_coordinates()
    • BufferCoord
    • SpongeFunction
    • GridMapping
      • GridMapping.none()
      • GridMapping.linear()
      • GridMapping.exponential()
      • GridMapping.tangential()
      • GridMapping.polar_to_cartesian()
    • Condition
    • Periodic
    • Initial
      • Initial.fields
    • Perturbation
      • Perturbation.fields
    • Buffer
    • GridDeformation
    • SpongeLayer
      • SpongeLayer.target_state
    • PSpongeLayer
    • Conditions
    • BoundaryConditions
      • BoundaryConditions.get_domain_boundaries()
    • DomainConditions
    • Examples
      • Predefined Cylinder Meshes
        • Unstructured mesh with a sponge layer
        • Structured O-grid mesh
      • NACA Airfoil Mesh
      • Structured Rectangular Meshes
        • Uniform channel mesh
        • Wall-clustered channel mesh
        • Two-domain channel with a downstream sponge region
      • Structured Cylinder Meshes
        • Uniform annular mesh
        • Radially clustered mesh
        • Two-domain mesh: fluid core and outer sponge annulus
dream
  • Search

© Copyright 2025.

Built with Sphinx using a theme provided by Read the Docs.