option lists (exa/docs!135) (e6077c81) · Commits · Janine Carney / docs

docs/source_docs/user_guide/inputs/initial_conditions.rst

+4 −4

Original line number	Diff line number	Diff line
		@@ -132,10 +132,10 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		\| \| * ``constant`` -- specified constant \| \| \|
		\| \| * ``uniform`` -- uniform distribution \| \| \|
		\| \| * ``normal`` -- normal distribution \| \| \|
		\| \| * ``custom`` -- user-defined distribution \| \| \|
		\| \| * ``constant`` - specified constant \| \| \|
		\| \| * ``uniform`` - uniform distribution \| \| \|
		\| \| * ``normal`` - normal distribution \| \| \|
		\| \| * ``custom`` - user-defined distribution \| \| \|
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| density.constant \| Monodisperse (single valued) particle density. \| Real \| 0 \|
		\| \| Required for ``constant`` distributions. \| \| \|

docs/source_docs/user_guide/inputs/multigrid_solvers.rst

+13 −8

Original line number	Diff line number	Diff line
		@@ -22,7 +22,7 @@ The following inputs are defined using the prefix ``nodal_proj``:
		\| maxiter \| Maximum number of iterations in the nodal projection. \| Int \| 100 \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_maxiter \| Maximum number of iterations in the nodal projection \| Int \| 100 \|
		\| \| bottom solver if using bicg, cg, bicgcg or cgbicg. \| \| \|
		\| \| bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in the nodal projection. \| Int \| 100 \|
		\| \| If set to 0, the bottom solver will be called at the current level. \| \| \|
		@@ -72,10 +72,10 @@ The following inputs are defined using the prefix ``mac_proj``:
		\| maxiter \| Maximum number of iterations in the MAC projection. \| Int \| 200 \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_maxiter \| Maximum number of iterations in the MAC projection \| Int \| 200 \|
		\| \| bottom solver if using bicg, cg, bicgcg or cgbicg. \| \| \|
		\| \| bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in the MAC projection \| Int \| 100 \|
		\| \| If set to 0, the bottom solver will be called at the current level \| \| \|
		\| \| If set to 0, the bottom solver will be called at the current level. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_solver \| Which bottom solver to use in the MAC projection. \| String \| bicgcg \|
		\| \| \| \| \|
		@@ -123,7 +123,7 @@ The following inputs are defined using the prefix ``diffusion``:
		\| bottom_maxiter \| Maximum number of iterations in diffusion solver \| Int \| 100 \|
		\| \| bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in diffusion solve \| Int \| 100 \|
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in diffusion solver. \| Int \| 100 \|
		\| \| If set to 0, the bottom solver will be called at the current level. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_solver \| Which bottom solver to use for diffusion. \| String \| bicgcg \|
		@@ -131,9 +131,10 @@ The following inputs are defined using the prefix ``diffusion``:
		\| \| Options: \| \| \|
		\| \| \| \| \|
		\| \| * ``bicgcg`` \| \| \|
		\| \| * ``cg`` - \| \| \|
		\| \| * ``cgbicg`` - \| \| \|
		\| \| * ``smoother`` - \| \| \|
		\| \| * ``bicgstab`` \| \| \|
		\| \| * ``cg`` \| \| \|
		\| \| * ``cgbigc`` \| \| \|
		\| \| * ``smoother`` \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+


		@@ -143,7 +144,7 @@ Hypre Settings
		`hypre` settings are specified using the following inputs which are read directly by AMReX when `hypre` is used as
		the bottom solver for the MAC and/or nodal projections. By default, these inputs are defined using the
		prefix ``hypre``, however different settings for the nodal and MAC projections can be used by specifying
		a ``hpyre_namespace`` for each solver.
		a ``hypre_namespace`` for each solver.

		.. warning::

		@@ -225,6 +226,10 @@ The following inputs are valid when using ``BoomerAMG`` as a preconditioner or s
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_down_sweeps \| See ``HYPRE_BoomerAMGSetCycleNumSweeps``. \| Int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_down_sweeps \| See ``HYPRE_BoomerAMGSetCycleNumSweeps``. \| Int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_sweeps \| See ``HYPRE_BoomerAMGSetNumSweeps``. \| Int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_sweeps \| See ``HYPRE_BoomerAMGSetNumSweeps``. \| int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_up_sweeps \| See ``HYPRE_BoomerAMGSetCycleNumSweeps``. \| Int \| 2 \|

Original line number	Diff line number	Diff line
		@@ -132,10 +132,10 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		\| \| * ``constant`` -- specified constant \| \| \|
		\| \| * ``uniform`` -- uniform distribution \| \| \|
		\| \| * ``normal`` -- normal distribution \| \| \|
		\| \| * ``custom`` -- user-defined distribution \| \| \|
		\| \| * ``constant`` - specified constant \| \| \|
		\| \| * ``uniform`` - uniform distribution \| \| \|
		\| \| * ``normal`` - normal distribution \| \| \|
		\| \| * ``custom`` - user-defined distribution \| \| \|
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| density.constant \| Monodisperse (single valued) particle density. \| Real \| 0 \|
		\| \| Required for ``constant`` distributions. \| \| \|

Original line number	Diff line number	Diff line
		@@ -22,7 +22,7 @@ The following inputs are defined using the prefix ``nodal_proj``:
		\| maxiter \| Maximum number of iterations in the nodal projection. \| Int \| 100 \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_maxiter \| Maximum number of iterations in the nodal projection \| Int \| 100 \|
		\| \| bottom solver if using bicg, cg, bicgcg or cgbicg. \| \| \|
		\| \| bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in the nodal projection. \| Int \| 100 \|
		\| \| If set to 0, the bottom solver will be called at the current level. \| \| \|
		@@ -72,10 +72,10 @@ The following inputs are defined using the prefix ``mac_proj``:
		\| maxiter \| Maximum number of iterations in the MAC projection. \| Int \| 200 \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_maxiter \| Maximum number of iterations in the MAC projection \| Int \| 200 \|
		\| \| bottom solver if using bicg, cg, bicgcg or cgbicg. \| \| \|
		\| \| bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in the MAC projection \| Int \| 100 \|
		\| \| If set to 0, the bottom solver will be called at the current level \| \| \|
		\| \| If set to 0, the bottom solver will be called at the current level. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_solver \| Which bottom solver to use in the MAC projection. \| String \| bicgcg \|
		\| \| \| \| \|
		@@ -123,7 +123,7 @@ The following inputs are defined using the prefix ``diffusion``:
		\| bottom_maxiter \| Maximum number of iterations in diffusion solver \| Int \| 100 \|
		\| \| bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in diffusion solve \| Int \| 100 \|
		\| mg_max_coarsening_level \| Maximum number of coarser levels to allow in diffusion solver. \| Int \| 100 \|
		\| \| If set to 0, the bottom solver will be called at the current level. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bottom_solver \| Which bottom solver to use for diffusion. \| String \| bicgcg \|
		@@ -131,9 +131,10 @@ The following inputs are defined using the prefix ``diffusion``:
		\| \| Options: \| \| \|
		\| \| \| \| \|
		\| \| * ``bicgcg`` \| \| \|
		\| \| * ``cg`` - \| \| \|
		\| \| * ``cgbicg`` - \| \| \|
		\| \| * ``smoother`` - \| \| \|
		\| \| * ``bicgstab`` \| \| \|
		\| \| * ``cg`` \| \| \|
		\| \| * ``cgbigc`` \| \| \|
		\| \| * ``smoother`` \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+--------------+


		@@ -143,7 +144,7 @@ Hypre Settings
		`hypre` settings are specified using the following inputs which are read directly by AMReX when `hypre` is used as
		the bottom solver for the MAC and/or nodal projections. By default, these inputs are defined using the
		prefix ``hypre``, however different settings for the nodal and MAC projections can be used by specifying
		a ``hpyre_namespace`` for each solver.
		a ``hypre_namespace`` for each solver.

		.. warning::

		@@ -225,6 +226,10 @@ The following inputs are valid when using ``BoomerAMG`` as a preconditioner or s
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_down_sweeps \| See ``HYPRE_BoomerAMGSetCycleNumSweeps``. \| Int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_down_sweeps \| See ``HYPRE_BoomerAMGSetCycleNumSweeps``. \| Int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_sweeps \| See ``HYPRE_BoomerAMGSetNumSweeps``. \| Int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_sweeps \| See ``HYPRE_BoomerAMGSetNumSweeps``. \| int \| 2 \|
		+-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| bamg_num_up_sweeps \| See ``HYPRE_BoomerAMGSetCycleNumSweeps``. \| Int \| 2 \|