From 2714164611eba808d0fe4f8bc0ec6eae236bed39 Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Thu, 13 Feb 2025 12:58:54 -0500 Subject: [PATCH] add refs --- Docs/source/comprehensive_tests.rst | 2 ++ Docs/source/one_zone_tests.rst | 2 ++ Docs/source/unit_test_runtime_parameters.rst | 4 ++-- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/Docs/source/comprehensive_tests.rst b/Docs/source/comprehensive_tests.rst index 5ea20ab66..32a4f507f 100644 --- a/Docs/source/comprehensive_tests.rst +++ b/Docs/source/comprehensive_tests.rst @@ -1,3 +1,5 @@ +.. _sec:comprehensive_tests: + ************************ Comprehensive Unit Tests ************************ diff --git a/Docs/source/one_zone_tests.rst b/Docs/source/one_zone_tests.rst index 8a34952ef..2cf8ea57b 100644 --- a/Docs/source/one_zone_tests.rst +++ b/Docs/source/one_zone_tests.rst @@ -1,3 +1,5 @@ +.. _sec:one_zone_tests: + ************** One Zone Tests ************** diff --git a/Docs/source/unit_test_runtime_parameters.rst b/Docs/source/unit_test_runtime_parameters.rst index 4584b833d..fc6232c44 100644 --- a/Docs/source/unit_test_runtime_parameters.rst +++ b/Docs/source/unit_test_runtime_parameters.rst @@ -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``, @@ -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