Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale committed Feb 18, 2025
1 parent a3c42c3 commit 025e22a
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 23 deletions.
92 changes: 69 additions & 23 deletions Docs/source/build_system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,34 +98,84 @@ controlled by a number of make variables.
will tell you what EOS is being used.


The following control whether certain physics modules are included in
the build process. Note: an EOS and network are always required.
These can be set to ``TRUE`` to enable and ``FALSE`` to disable.
disable specific features.

* ``USE_CONDUCTIVITY`` : determines whether a conductivity routine
should be included in the list of build packages. If enabled, this
also defines the ``CONDUCTIVITY`` preprocessor variable. Default:
``FALSE``.

USE_CONDUCTIVITY
USE_NEUTRINOS
USE_SCREENING
USE_RATES
USE_REACT
USE_NONAKA_PLOT
* ``USE_NEUTRINOS`` : determines whether a neutrino cooling term
should be applied in the reaction network energy generation
equation. See :ref:`neutrino_loss`. The default is set by each
individual network.

USE_SIMPLIFIED_SDC
USE_TRUE_SDC
* ``USE_NET_NET`` : determines whether the self-consistent NSE
infrastructure is included in the build. See
:ref:`self_consistent_nse`. No default is set.

* ``USE_NSE_TABLE`` : determines whether the tabular NSE
infrastructure is included in the build. See :ref:`tabulated_nse`.
No default is set.

* ``USE_RATES`` : for templated reaction networks (see
:ref:`sec:templated_rhs`) determines whether we include the
``rates/`` set of reaction rates in the build system. Also defines
the ``RATES`` preprocessor variable. The default is set by each of
the templated networks separately.

* ``USE_REACT`` : determines whether we need to include any of the
source related to reaction networks or integrators and sets the
``REACTIONS`` preprocessor variable. Note: even if this is set to
``TRUE``, the ``network_properties.H`` file is still generated. No
default is set.

* ``USE_SCREENING`` : determines whether the screening routines are
included in the list of build packages. If enabled, this also
defines the ``SCREENING`` preprocessor variable which is used in
some networks to disable screening completely. Note: it is also
possible to set the screening routine to ``null`` which would have
the same effect (see :ref:`sec:screening`). The default is set by
each individual network.


The following control the choice of implementation for the different physics modules:


* ``CONDUCTIVITY_DIR`` : the name of the conductivity implementation to use,
relative to ``Microphysics/conductivity/``.

* ``EOS_DIR`` : the name of the EOS to use, relative to ``Microphysics/EOS/``.

* ``INTEGRATOR_DIR`` : the name of the integrator to use, relative to
``Microphysics/integration/``.

* ``NETWORK_DIR`` : the name of the network to use, relative to ``Microphysics/networks/``.
If ``general_null`` is chosen, then the inputs file is determined by
either ``GENERAL_NET_INPUTS`` or ``NETWORK_INPUTS`` (see :ref:`sec:networks:general_null`).

* ``OPACITY_DIR`` : the name of the opacity implementation to use, relative
to ``Microphysics/opacity/``.

* ``SCREEN_METHOD`` : the name of the screening implementation to use. The choices
are listed in :ref:`sec:screening`.


The following control the time-integration method used by the reaction
network integration:

* ``USE_SIMPLIFIED_SDC``

* ``USE_TRUE_SDC``

SCREEN_METHOD

USE_AUX_THERMO

EOS_DIR
OPACITY_DIR
NETWORK_DIR
CONDUCTIVITY_DIR

GENERAL_NET_INPUTS
NETWORK_INPUTS

USE_NSE_TABLE
USE_NET_NET

USE_RAD

Targets
=======
Expand All @@ -143,7 +193,3 @@ clean
runtime parameters

buildInfo


Querying the build variables
============================
4 changes: 4 additions & 0 deletions Docs/source/networks.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _sec:networks:

***************************
Available Reaction Networks
***************************
Expand Down Expand Up @@ -25,6 +27,8 @@ Microphysics knows the properties of the fluid.
<https://pynucastro.github.io/>`_ using the ``AmrexAstroCxxNetwork``
class.

.. _sec:networks:general_null:

``general_null``
================

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

***************************
Screening of Reaction Rates
***************************
Expand Down

0 comments on commit 025e22a

Please sign in to comment.