Skip to content

Commit

Permalink
add refs
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale committed Feb 13, 2025
1 parent e3fd270 commit 2714164
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions Docs/source/comprehensive_tests.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _sec:comprehensive_tests:

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

**************
One Zone Tests
**************
Expand Down
4 changes: 2 additions & 2 deletions Docs/source/unit_test_runtime_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Most of the unit tests require a composition to be defined (for the
initial mass-fractions, $X_k$). There are a few ways this can be done
(depending on the test).

* One-zone (``*_cell``) tests usually do one of:
* One-zone (``*_cell``) tests (see :ref:`sec:one_zone_tests`) usually do one of:

* *Explicitly setting the individual mass fractions.* This is
controlled by the parameters ``unit_test.X1``, ``unit_test.X2``, ..., ``unit_test.X35``,
Expand All @@ -45,7 +45,7 @@ initial mass-fractions, $X_k$). There are a few ways this can be done
``unit_test.uniform_xn``. If this is set to ``1``, then each mass fraction
is initialized to ``1 / NumSpec``.

* Comprehensive tests need many different compositions, since they are creating a cube
* Comprehensive tests (see :ref:`sec:comprehensive_tests`) need many different compositions, since they are creating a cube
of varying thermodynamic properties, and thus require a prescription
to create the composition. This is done by setting ``unit_test.primary_species_1``,
``unit_test.primary_species_2``, and ``unit_test.primary_species_3`` to one of the
Expand Down

0 comments on commit 2714164

Please sign in to comment.