Skip to content

Latest commit

 

History

History
113 lines (89 loc) · 2.66 KB

index.rst

File metadata and controls

113 lines (89 loc) · 2.66 KB

AMReX-Astro Microphysics

AMReX-Astro Microphysics is a collection of microphysics routines (equations of state, reaction networks, ...) and utilities (ODE integrators, NSE solvers) for astrophysical simulation codes.

The original design was to support codes based on the AMReX adaptive mesh refinement library :cite:`amrex_joss`, including CASTRO :cite:`castro_I`, MAESTROeX :cite:`maestroex`, and, later, Quokka :cite:`quokka`. These all have a consistent interface and the separate Microphysics repository allows them to share the same equation of state, reaction networks, and more.

Microphysics is written in C++ as a (mostly) header-only library, making extensive use of templating and C++ constexpr features to be performant on both CPU and GPU architectures. It is compatible with both NVIDIA CUDA and AMD HIP/ROCm.

While there are a number of unit tests that exercise the functionality, Microphysics is primarily intended to be used along with another simulation code. At the moment, the interfaces and build stubs are compatible with the AMReX codes and use the AMReX build system.

Note

A number of the routines contained here we authored by other people. We bundle them here with permission, usually changing the interfaces to be compatible with our standardized interface. We in particular thank Frank Timmes for numerous reaction networks and his equation of state routines.

.. toctree::
   :maxdepth: 1
   :caption: Microphysics overview
   :hidden:

   getting_started
   design
   data_structures
   rp_intro

.. toctree::
   :maxdepth: 1
   :caption: EOS and transport
   :hidden:

   eos
   eos_implementations
   transport

.. toctree::
   :maxdepth: 1
   :caption: Reaction networks
   :hidden:

   networks-overview
   networks
   templated_networks
   screening
   neutrinos

.. toctree::
   :maxdepth: 1
   :caption: ODE integrators
   :hidden:

   integrators
   ode_integrators
   nse
   sdc

.. toctree::
   :maxdepth: 1
   :caption: Util / external libraries
   :hidden:

   util
   autodiff

.. toctree::
   :maxdepth: 1
   :caption: Unit tests
   :hidden:

   unit_tests
   unit_test_runtime_parameters
   comprehensive_tests
   one_zone_tests

.. toctree::
   :maxdepth: 1
   :caption: References
   :hidden:

   citing
   changes
   zreferences

.. toctree::
   :maxdepth: 1
   :caption: Index
   :hidden:

   genindex