Documentation: Runtime Parameters

* Update the chapter on runtime parameters. * Add amrex prefix to a number of obscure parameters. This should not cause any backward compatibility issues. * For uncommon parameters, use query instread of queryAdd. So the user will not see them when print out all parameters. * Remove fab.init_snan because there is now amrex.init_snan.
AMReX-Codes · Jul 31, 2024 · b19b42c · b19b42c
1 parent 83ecf62
commit b19b42c
Show file tree

Hide file tree

Showing 44 changed files with 1,428 additions and 413 deletions.
diff --git a/Docs/sphinx_documentation/source/Basics.rst b/Docs/sphinx_documentation/source/Basics.rst
@@ -278,6 +278,9 @@ runtime error that will abort the run.
 Math Expressions
 ----------------
 
+.. versionadded:: 24.08
+ Math expression support in :cpp:`ParmParse`.
+
 :cpp:`ParmParse` supports math expressions for integers and floating point
 numbers. For example,
 
@@ -600,6 +603,9 @@ literals. Additionally, a floating point like number with a positive
 exponent may be accepted as an integer if it is reasonable to do so. For
 example, it's okay to have ``1.234e3``, but ``1.234e2`` is an error.
 
+ .. versionadded:: 24.08
+ Support for ``'`` and ``e`` in :cpp:`IParser` integers.
+
 .. _sec:basics:initialize:
 
 Initialize and Finalize
@@ -1057,7 +1063,7 @@ an :cpp:`int` pointer or array specifying periodicity. If a :cpp:`RealBox` is no
 given in the first constructor, AMReX will construct one based on :cpp:`ParmParse` parameters,
 ``geometry.prob_lo`` / ``geometry.prob_hi`` / ``geometry.prob_extent``,
 where each of the parameter is an array of ``AMREX_SPACEDIM`` real numbers.
-See the section on :ref:`sec:inputs:pd` for more details about how to specify these.
+See the section on :ref:`sec:inputs:geom` for more details about how to specify these.
 
 The argument for coordinate system is an integer type with
 valid values being 0 (Cartesian), or 1 (cylindrical), or 2 (spherical). If it

diff --git a/Docs/sphinx_documentation/source/InputsCheckpoint.rst b/Docs/sphinx_documentation/source/InputsCheckpoint.rst
diff --git a/Docs/sphinx_documentation/source/InputsComputeBackends.rst b/Docs/sphinx_documentation/source/InputsComputeBackends.rst
diff --git a/Docs/sphinx_documentation/source/InputsLoadBalancing.rst b/Docs/sphinx_documentation/source/InputsLoadBalancing.rst
diff --git a/Docs/sphinx_documentation/source/InputsPlotFiles.rst b/Docs/sphinx_documentation/source/InputsPlotFiles.rst
diff --git a/Docs/sphinx_documentation/source/InputsProblemDefinition.rst b/Docs/sphinx_documentation/source/InputsProblemDefinition.rst
diff --git a/Docs/sphinx_documentation/source/InputsTimeStepping.rst b/Docs/sphinx_documentation/source/InputsTimeStepping.rst
diff --git a/Docs/sphinx_documentation/source/Inputs_Chapter.rst b/Docs/sphinx_documentation/source/Inputs_Chapter.rst