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

more work on the docs intro #1735

Merged
merged 1 commit into from
Feb 7, 2025
Merged
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
2 changes: 2 additions & 0 deletions Docs/source/burn_cell.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _sec:burn_cell:

*************
``burn_cell``
*************
16 changes: 13 additions & 3 deletions Docs/source/getting_started.rst
Original file line number Diff line number Diff line change
@@ -58,17 +58,27 @@ one-zone burn. In ``Microphysics/`` do:
cd unit_test/burn_cell
make

This will create an executable called ``main3d.gnu.ex``. Then you can run it as:
This will create an executable called ``main3d.gnu.ex``.
By default, the test is built with the 13-isotope ``aprox13`` network,
``helmholtz`` EOS, and VODE integrator.


Then you can run it as:

.. prompt:: bash

./main3d.gnu.ex inputs_aprox13

By default, the test is built with the 13-isotope ``aprox13`` network,
``helmholtz`` EOS, and VODE integrator.
Here ``inputs_aprox13`` is the inputs file that sets options.

This will output information about the starting and final state to the
terminal and produce a file ``state_over_time.txt`` that contains the
thermodynamic history at different points in time.

.. note::

See the :ref:`sec:burn_cell` documentation for more details on this
unit test and how to visualize the output.

Running with AMReX Application Code
===================================
3 changes: 1 addition & 2 deletions Docs/source/rp_intro.rst
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ The behavior of the network and EOS are controlled by many runtime
parameters. These parameters are defined in plain-text files
``_parameters`` located in the different directories that hold the
microphysics code. At compile time, a script in the AMReX build
system, findparams.py, locates all of the ``_parameters`` files that
system, ``findparams.py``, locates all of the ``_parameters`` files that
are needed for the given choice of network, integrator, and EOS, and
assembles all of the runtime parameters into a set of header files
(using the ``write_probin.py`` script).
@@ -32,4 +32,3 @@ noted in separate tables.
.. toctree::

runtime_parameters