Clean up docs (exa/docs!128) (3c23bca8) · Commits · Bhargav Sriram Siddani / docs

docs/source_docs/user_guide/inputs/advanced.rst

+5 −5

Original line number	Diff line number	Diff line
		@@ -35,15 +35,15 @@ The following inputs must be preceded by "amrex."
		GPU memory
		----------

		The following inputs must be preceded by "amrex."
		The following inputs must be preceded by the prefix ``amrex``:

		+----------------------------+-----------------------------------------------------------------------+-------------+---------------+
		\| \| Description \| Type \| Default \|
		+============================+=======================================================================+=============+===============+
		\| the_arena_is_managed \| Use managed memory for the main arena. \| Int \| 0 \|
		+----------------------------+-----------------------------------------------------------------------+-------------+---------------+
		\| the_arena_init_size \| Main memory arena's initial size in bytes. \| Int \| 3/4 of system \|
		\| \| \| \| device memory \|
		\| the_arena_init_size \| Initial size of main memory arena (bytes). If not specified, use \| Int \| Unspecified \|
		\| \| 3/4 of system device memory. \| \| \|
		+----------------------------+-----------------------------------------------------------------------+-------------+---------------+
		\| abort_on_out_of_gpu_memory \| Abort if free device memory is less than the amount an arena is \| Int \| 0 \|
		\| \| asked to allocate. \| \| \|
		@@ -58,7 +58,7 @@ the ``particles.max_grid_size`` (in each direction) have no meaning. Therefore t
		sizes should be set for particle load balancing. It may also be necessary to set the blocking factors to 1.


		The following inputs must be preceded by ``mfix`` and determine how we load balance:
		The following inputs must be preceded by the prefix ``mfix`` and control load balancing:

		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| \| Description \| Type \| Default \|
		@@ -88,7 +88,7 @@ To allow a user to verify the breakdown of fluid grids created before running a
		minimal memory to print the grid coverage report and exits immediately after that.


		The following inputs are defined using the ``particles`` prefix.
		The following inputs are defined using the prefix ``particles``:

		+----------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| \| Description \| Type \| Default \|

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+5 −5

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@ Boundary Conditions
		General boundary conditions
		---------------------------

		The following inputs are defined using the ``bc`` prefix.
		The following inputs are defined using the prefix ``bc``:

		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		@@ -36,7 +36,7 @@ Fluid settings
		~~~~~~~~~~~~~~

		For each boundary condition region, the fluid inputs are defined
		using the ``bc.[region].[fluid]`` prefix.
		using the prefix ``bc.[region].[fluid]``:


		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		@@ -51,13 +51,13 @@ using the ``bc.[region].[fluid]`` prefix.
		\| temperature \| Fluid temperature [required if bc_region_type='mi' or 'pi'] \| Real \| 0 \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| velocity \| Velocity components [required if bc_region_type='mi' \| Reals \| 0 0 0 \|
		\| \| and volflow or massflow not specified] \| \| \|
		\| \| and ``volflow`` or ``massflow`` not specified] \| \| \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| volflow \| Volumetric flow rate [required if bc_region_type='mi' \| Real \| 0 \|
		\| \| and velocity or massflow not specified] \| \| \|
		\| \| and ``velocity`` or ``massflow`` not specified] \| \| \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| massflow \| Mass flow rate [required if bc_region_type='mi' \| Real \| 0 \|
		\| \| and velocity or volflow not specified] \| \| \|
		\| \| and ``velocity`` or ``volflow`` not specified] \| \| \|
		+------------------------+------------------------------------------------------------------------+-------------+-----------+
		\| delp_dir \| Direction for specified pressure drop. Note that this direction \| Int \| 0 \|
		\| \| should also be periodic. \| \| \|

docs/source_docs/user_guide/inputs/chemical_reactions.rst

+3 −3

Original line number	Diff line number	Diff line
		Chemical Reactions
		==================

		The following inputs are defined using the ``chemistry`` prefix.
		The following inputs are defined using the prefix ``chemistry``:

		+--------------------------+---------------------------------------------------------+----------+----------------+
		\| \| Description \| Type \| Default \|
		@@ -47,7 +47,7 @@ The following inputs are defined using the ``chemistry`` prefix.

		Choosing the integrator type for the chemistry ODE integration operation that is
		performed to determine the fluid and solids phases transfer quantities due to
		chemical reactions. The ``StiffSolver`` class of integrators is inspired to the
		chemical reactions. The ``StiffSolver`` class of integrators is inspired by the
		class of integrators in AMReX-Astro/Microphysics
		(https://github.com/AMReX-Astro/Microphysics)

		@@ -68,7 +68,7 @@ One can define the environment variable ``VODE_JACOBIAN_CACHING`` at compile
		time to enable caching of the numerical approximation of the Jacobian matrix
		(the derivative of the ODE right-hand side), applicable when the VODE integrator
		is selected. The following inputs can be specified using the
		``chemistry.integrator`` prefix:
		prefix ``chemistry.integrator``:

		+-----------------------+---------------------------------------------------------------------+--------+-----------+
		\| \| Description \| Type \| Default \|

docs/source_docs/user_guide/inputs/domain.rst

+1 −1

Original line number	Diff line number	Diff line
		@@ -6,7 +6,7 @@ Defining the domain
		All simulations, whether using an embedded boundary (EB) or not, are specified on a simple cuboid domain. The
		low and high corners of the cuboid are defined by the ``prob_lo`` and ``prob_hi`` inputs.

		The following inputs are defined using the ``geometry`` prefix.
		The following inputs are defined using the prefix ``geometry``:

		.. _InputsTable_domain:

docs/source_docs/user_guide/inputs/fluid_model.rst

+6 −6

Original line number	Diff line number	Diff line
		@@ -3,7 +3,7 @@
		Fluid model
		===========

		The following inputs are defined using the ``fluid`` prefix.
		The following inputs are defined using the prefix ``fluid``:

		+--------------------------------------------+-------------------------------------------------------------+--------+----------+
		\| \| Description \| Type \| Default \|
		@@ -15,7 +15,7 @@ The following inputs are defined using the ``fluid`` prefix.
		+--------------------------------------------+-------------------------------------------------------------+--------+----------+


		The root prefix for the following inputs use the name defined using the ``fluid.solve`` keyword. For example, if the fluid solver
		The root prefix for the following inputs is the name defined using the ``fluid.solve`` keyword. For example, if the fluid solver
		is named ``myfluid``, then the following keywords are preceded with ``myfluid`` and a period. Currently, MFIX-Exa only supports
		a single fluid; therefore, it is common to name the fluid ``fluid``. This is illustrated later in example input snippets.

		@@ -70,9 +70,9 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill
		\| \| \| \| \|
		\| \| A value is required for ``Sutherland`` viscosity model. \| \| \|
		+--------------------------------------------+------------------------------------------------------------+--------+----------+
		\| viscosity.molecular.Reid.A, \| Reid model constants \| Real \| 0 \|
		\| viscosity.molecular.Reid.B, \| \| \| \|
		\| viscosity.molecular.Reid.C, and \| Values are required for ``Reid`` viscosity model. \| \| \|
		\| viscosity.molecular.Reid.A \| Reid model constants \| Real \| 0 \|
		\| viscosity.molecular.Reid.B \| \| \| \|
		\| viscosity.molecular.Reid.C \| Values are required for ``Reid`` viscosity model. \| \| \|
		\| viscosity.molecular.Reid.D \| \| \| \|
		+--------------------------------------------+------------------------------------------------------------+--------+----------+
		\| viscosity.eddy \| Specify eddy viscosity model. \| String \| None \|
		@@ -412,7 +412,7 @@ thermodynamic pressure for the system.
		bc.outlet.fluid0.pressure = 101325.


		The following inputs are defined using the ``fluid`` prefix and control the convergence criteria
		The following inputs are defined using the prefix ``fluid`` and control the convergence criteria
		of the damped Newton solver used to compute temperature from enthalpy and specific heat.

		+------------------------------------------+----------------------------------------------------------+--------+----------+