Welcome to AMReX-Hydro’s Documentation

AMReX-Hydro is set of routines that support the construction of convective terms for incompressible and low Mach number flow modeling. It supports Cartesian coordinates with (or without) embedded boundaries and R-Z coordinate systems. It’s freely available on GitHub: https://github.com/AMReX-Codes/AMReX-Hydro .

AMReX-Hydro is built on top of AMReX: https://github.com/AMReX-Codes/amrex , a publicly available software framework designed for building massively parallel block-structured adaptive mesh refinement (AMR) applications.

Contents:

• Introduction
• Installation Guide
  • Clone, Configure and Install AMReX
  • Clone and Configure AMReX-Hydro
  • Make The Object Files
• Advection Schemes
  • Notation
  • Method of Lines (MOL)
  • Method of Lines with Embedded Boundaries (EBMOL)
  • Godunov Methods
  • Godunov with Embedded Boundaries (EBGodunov)
  • BDS Algorithm
• Projection Methods
  • MAC Projection
  • Nodal Projection
• Helper functions
  • Notation
  • Slopes
  • EB Slopes
  • Boundary conditions
  • Computing Fluxes
  • Constructing the advective term

References

• References

API documentation can be found in the Doxygen Technical Reference.