Skip to content

Commit 4e8dcb7

Browse files
committed
add notes about EOS_DIR and NETWORK_DIR and index them
1 parent 3130448 commit 4e8dcb7

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

Docs/source/eos_implementations.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@
22
Available Equations of State
33
****************************
44

5-
.. index:: eos_t
5+
.. index:: eos_t, EOS_DIR
66

77
The following equations of state are available in Microphysics.
88

9+
.. note::
10+
11+
The EOS is chosen at compile-time via the ``EOS_DIR`` make
12+
variable.
13+
914
.. note::
1015

1116
Except where noted, each of these EOSs will provide the full

Docs/source/networks.rst

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ of state and transport coefficient routines. Even if there are no
77
reactions taking place, a network still needs to be defined, so
88
Microphysics knows the properties of the fluid.
99

10+
.. index:: NETWORK_DIR
11+
12+
.. note::
13+
14+
The network is set at compile-time via the ``NETWORK_DIR``
15+
make variable.
16+
1017
.. tip::
1118

1219
If reactions can be ignored, then the ``general_null`` network can
@@ -21,6 +28,8 @@ Microphysics knows the properties of the fluid.
2128
``general_null``
2229
================
2330

31+
.. index:: general_null
32+
2433
``general_null`` is a bare interface for a nuclear reaction network ---
2534
no reactions are enabled. The
2635
data in the network is defined at compile type by specifying an

0 commit comments

Comments
 (0)