Skip to content

Commit 9aae2c9

Browse files
committed
update make docs
1 parent 76b1d85 commit 9aae2c9

File tree

2 files changed

+43
-13
lines changed

2 files changed

+43
-13
lines changed

Docs/source/build_system.rst

+39-13
Original file line numberDiff line numberDiff line change
@@ -167,29 +167,55 @@ The following control the choice of implementation for the different physics mod
167167
The following control the time-integration method used by the reaction
168168
network integration:
169169

170-
* ``USE_SIMPLIFIED_SDC``
170+
* ``USE_SIMPLIFIED_SDC`` : enable the simplified-SDC coupling of hydro and reactions.
171+
See :ref:`sec:simplified_sdc`.
171172

172-
* ``USE_TRUE_SDC``
173+
* ``USE_TRUE_SDC`` : enable the true-SDC coupling of hydro and reactions.
174+
See :ref:`sec:true_sdc`.
173175

176+
.. note::
174177

178+
If neither of these are set to ``TRUE``, then Strang-splitting coupling
179+
will be used.
175180

176181

182+
Targets
183+
=======
177184

185+
For the unit tests, simply doing
178186

187+
.. code:: bash
179188
180-
Targets
181-
=======
189+
make
190+
191+
in the test directory will build the test. There are a few other targets defined. The most important
192+
is ``clean``. Doing:
193+
194+
.. code:: bash
195+
196+
make clean
197+
198+
will remove all the build temporary files (including the ``tmp_build_dir/``).
199+
200+
.. important::
201+
202+
If you want to use a different EOS or reaction network (or any other physics), then you
203+
should always do ``make clean`` first in the build directory.
204+
205+
Some other targets include:
206+
207+
* ``nettables`` : create the symlinks for any weak reaction rate tables that are part of the
208+
network.
182209

183-
nettables
184-
table
185-
nsetable
186-
build_status
187-
test_extern_params
188-
net_prop_debug
210+
* ``table`` : create a symlink for the ``helm_table.dat`` EOS table if the ``helmholtz`` EOS is used.
189211

190-
clean
212+
* ``nsetable`` : create a symlink the NSE table if ``USE_NSE_TABLE=TRUE`` is set.
191213

214+
* ``build_status`` : report the current git versions of Microphysics and AMReX
192215

193-
runtime parameters
216+
* ``test_extern_params`` : this will simply parse the runtime parameters and execute the
217+
``write_probin.py`` script that generates the headers and C++ files necessary to use
218+
the parameters. These will be generated under ``tmp_build_dir/microphysics_sources/``.
194219

195-
buildInfo
220+
* ``net_prop_debug`` : this will simply create the ``network_properties.H`` file for the
221+
current network and output it into ``tmp_build_dir/microphysics_sources/``.

Docs/source/sdc.rst

+4
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ is the reaction source term.
4444
are supported by the same integrators, and both of these options
4545
will set the ``SDC`` preprocessor flag.
4646

47+
.. _sec:true_sdc:
48+
4749
"True" SDC
4850
----------
4951

@@ -86,6 +88,8 @@ This can be cast as an ODE system as:
8688
8789
\frac{d\Uc}{dt} \approx \frac{\Uc^{m+1} - \Uc^m}{\delta t_m} = \Rbs{\Uc} + {\bf C}
8890
91+
.. _sec:simplified_sdc:
92+
8993
Simplified SDC
9094
--------------
9195

0 commit comments

Comments
 (0)