Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update the docs on the indices in burn_t #1716

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions Docs/source/data_structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
========
Expand Down Expand Up @@ -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
===========

Expand Down
2 changes: 2 additions & 0 deletions Docs/source/sdc.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _sdc-evolution:

*****************************
Spectral Deferred Corrections
*****************************
Expand Down
Loading