Skip to content

Commit

Permalink
document the shock burning flag (#2631)
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale authored Oct 11, 2023
1 parent 9b81621 commit d2ace11
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions Docs/source/reactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,32 @@ in the inputs file. Reactions are enabled by setting::
the efficiency).

It is possible to set the maximum and minimum temperature and density for allowing
reactions to occur in a zone using the parameters ``castro.react_T_min``,
``castro.react_T_max``, ``castro.react_rho_min`` and ``castro.react_rho_max``.
reactions to occur in a zone using the parameters:

* ``castro.react_T_min`` and ``castro.react_T_max`` for temperature

* ``castro.react_rho_min`` and ``castro.react_rho_max`` for density

.. index:: castro.disable_shock_burning, USE_SHOCK_VAR

Burning can also be disabled inside shocks. This requires that the code be
compiled with::

USE_SHOCK_VAR = TRUE

in the ``GNUmakefile``. This will allocate storage for a shock flag in the conserved
state array. This flag is computed via a multidimensional shock detection algorithm
that looks for compression (:math:`\nabla \cdot \ub < 0`) along with a pressure jump
in the direction of compression. The runtime parameter::

castro.disable_shock_burning = 1

will skip reactions in a zone where we've detected a shock.

.. note::

Both the compilation with ``USE_SHOCK_VAR = TRUE`` and the runtime parameter
``castro.disable_shock_burning = 1`` are needed to turn off burning in shocks.

Reactions Flowchart
===================
Expand Down

0 comments on commit d2ace11

Please sign in to comment.