From bff2d261b5ce7f97a0d80682ad43432609533a2c Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Mon, 13 Jan 2025 16:27:43 -0500 Subject: [PATCH] update the docs on the indices in burn_t --- Docs/source/data_structures.rst | 24 ++++++++++++++++++++++-- Docs/source/sdc.rst | 2 ++ 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/Docs/source/data_structures.rst b/Docs/source/data_structures.rst index 8a4c4ccc3..1e130d4b7 100644 --- a/Docs/source/data_structures.rst +++ b/Docs/source/data_structures.rst @@ -43,7 +43,7 @@ network, and they will come in through the ``network_properties.H`` header file. There is a lot more information that can be saved here, such as the partial derivatives of the thermodynamic state variables with respect to each other. To see a complete list, examine the ``eos_type.H`` -file: ``Castro/Microphysics/interfaces/eos_type.H``. +file. Networks ======== @@ -111,10 +111,30 @@ to access the different components of the state: * ``neqs`` : the total number of variables we are integrating. - It is assumed that the first ``nspec`` are the species. + It is assumed that the first ``nspec`` are the species. * ``net_ienuc`` : the index of the specific internal energy in the solution vector +For :ref:`sdc-evolution`, it also defines integer indices for the +``burn_t y[]`` array: + +* ``SFS``: the first species + +* ``SEINT`` the energy + +and then a number of components that are not evolved: + +* ``SRHO`` density + +* ``SMX``, ``SMY``, ``SMZ`` : the momenta + +* ``SEDEN`` : the total energy density + +* ``SFX`` : the first auxiliary quantity + +with the total number of state variables ``SVAR`` and the number of evolved +variables ``SVAR_EVOLVE``. + Integrators =========== diff --git a/Docs/source/sdc.rst b/Docs/source/sdc.rst index 1d9b52e29..2eed54cce 100644 --- a/Docs/source/sdc.rst +++ b/Docs/source/sdc.rst @@ -1,3 +1,5 @@ +.. _sdc-evolution: + ***************************** Spectral Deferred Corrections *****************************