Skip to content

Commit

Permalink
Update documentation regarding species sources and normalization (#2742)
Browse files Browse the repository at this point in the history
This PR updates the Hydrodynamics section documentation to highlight that sources for passive variables in the conserved state are off by default. It also removes the reference to castro.normalize_species, which does not appear to be a valid runtime parameter any longer. I am happy to introduce additional documentation regarding the species normalization if that would be helpful -- my understanding is that it is on by default now.
  • Loading branch information
KiranEiden authored Feb 13, 2024
1 parent 62193e9 commit 1bdc650
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions Docs/source/Hydrodynamics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,14 @@ accounted for in **Steps 1** and **6**. The source terms are:
S_{{\rm ext},\rho Y_k}
\end{array}\right)^n.
.. index:: USE_SPECIES_SOURCES

.. note:: To reduce memory usage, we do not include source terms for the
advected quantities, species, and auxiliary variables in the conserved
state vector by default. If your application needs external source terms for
these variables, set `USE_SPECIES_SOURCES=TRUE` when compiling so that space
will be allocated for them.

Primitive Forms
===============

Expand Down Expand Up @@ -585,9 +593,6 @@ runtime parameters for hydrodynamics:

See :ref:`sponge_section` for more details on the sponge.

- ``castro.normalize_species``: enforce that :math:`\sum_i X_i = 1`
(0 or 1; default: 0)

.. index:: castro.small_dens, castro.small_temp, castro.small_pres

Several floors are imposed on the thermodynamic quantities to prevet unphysical
Expand Down

0 comments on commit 1bdc650

Please sign in to comment.