add all keys from benchmarks, tutorials, tests (!193) · Merge requests · exa / docs

docs/source_docs/references/size_distributions.rst

+1 −1

Changes for docs/source_docs/references/size_distributions.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -51,7 +51,7 @@ The ``constant`` distribution defines a monodisperse (single-valued) distributio
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		+=====================+=======================================================================+=============+===========+
		\| constant \| size of the mono-disperse distribution \| Real \| N/A \|
		\| constant \| size of the monodisperse distribution \| Real \| N/A \|
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+

		In the following example, a cuboid is filled with 1 mm diameter monodisperse particles with 2500 kg\ \|cdot\|\ m\ :sup:`-3`

docs/source_docs/test_benchmarks/qualitative_bencharks/biseg.rst

+1 −1

Changes for docs/source_docs/test_benchmarks/qualitative_bencharks/biseg.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -42,4 +42,4 @@ into the oversegregation in this case is ongoing.
		:alt: Sim comparison to bidisperse segregation experiment at NETL

		Comparison of experiment and MFIX-Exa simulaton for rapid segregation
		of a bi-disperse particle mixture.
		of a bidisperse particle mixture.

docs/source_docs/user_guide/inputs/advanced.rst

+15 −7

Changes for docs/source_docs/user_guide/inputs/advanced.rst: 15 added lines, 7 removed lines.
Original line number	Diff line number	Diff line
		@@ -73,28 +73,28 @@ 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 the prefix ``mfix`` and control load balancing:
		The following inputs must be preceded by the prefix ``mfix.load_balance`` and control load balancing:

		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| \| Description \| Type \| Default \|
		+==================================+=======================================================================+=============+===================+
		\| \| Grid type. \| String \| SingleGrid \|
		\| grid_type \| Grid type. \| String \| SingleGrid \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		\| load_balance \| * ``SingleGrid`` - fluid and particles are co-located on the same grid\| \| \|
		\| \| * ``SingleGrid`` - fluid and particles are co-located on the same grid\| \| \|
		\| \| * ``DualGrid`` - fluid and particles occupy different grids \| \| \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| load_balance.DualGrid.fluid \| Regrid mesh (fluid) in addition to particles when using `DualGrid` \| Int \| 0 \|
		\| DualGrid.fluid \| Regrid mesh (fluid) in addition to particles when using `DualGrid` \| Int \| 0 \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| load_balance.strategy \| Strategy to use for dynamic load balancing. \| String \| KnapSack \|
		\| strategy \| Strategy to use for dynamic load balancing. \| String \| KnapSack \|
		\| \| \| \| \|
		\| \| Options (case-insensitive): \| \| \|
		\| \| \| \| \|
		\| \| * ``KnapSack`` \| \| \|
		\| \| * ``SFC`` \| \| \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| load_balance.weighting \| Weighting function to use if using ``KnapSack`` load balancing \| String \| ParticleRunTime \|
		\| weighting \| Weighting function to use if using ``KnapSack`` load balancing \| String \| ParticleRunTime \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		@@ -102,7 +102,7 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba
		\| \| * ``ParticleCount`` \| \| \|
		\| \| * ``CellCount`` \| \| \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| knapsack_nmax \| Maximum number of grids per MPI process if using knapsack algorithm \| Int \| 128 \|
		\| knapsack.nmax \| Maximum number of grids per MPI process if using knapsack algorithm \| Int \| 128 \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+


		@@ -120,3 +120,11 @@ The following inputs are defined using the prefix ``particles``:
		\| max_grid_size_z \| Maximum number of cells at level 0 in each grid in z-direction \| Int \| 32 \|
		\| \| for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.\| \| \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+

		The following input is defined using the prefix ``eb2``:

		+----------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| \| Description \| Type \| Default \|
		+======================+=======================================================================+=============+==============+
		\| max_grid_size \| Specifies the maximum grid size in AMReX's internal EB database. \| Int \| 64 \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+

docs/source_docs/user_guide/inputs/model_options.rst

+17 −14

Changes for docs/source_docs/user_guide/inputs/model_options.rst: 17 added lines, 14 removed lines.
Original line number	Diff line number	Diff line
		@@ -38,9 +38,9 @@ Fluid options

		The following inputs are defined using the prefix ``mfix``:

		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| \| Description \| Type \| Default \|
		+=================================+============================================================================+=============+=====================+
		+======================================+============================================================================+=============+=====================+
		\| constraint \| Select low Mach number constraint. \| String \| IncompressibleFluid \|
		\| \| \| \| \|
		\| \| Options (case-insensitive): \| \| \|
		@@ -59,14 +59,14 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| The thermodynamic pressure evolves in time to balance processes like \| \| \|
		\| \| chemical reactions. \| \| \|
		\| \| \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| thermodynamic_pressure \| Thermodynamic pressure. \| Real \| 0 \|
		\| \| A value is required when using the \| \| \|
		\| \| ``IdealGasClosedSystem`` constraint. If using the \| \| \|
		\| \| ``IdealGasOpenSystem`` constraint, if a value is provided then it must \| \| \|
		\| \| match all specified outflow pressures. \| \| \|
		\| \| \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| advection_type \| Advection scheme. \| String \| Godunov \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		@@ -78,13 +78,13 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| * ``Godunov`` - Godunov. MAC velocities and edge states are \| \| \|
		\| \| extrapolated in space and time using a second-order Taylor series \| \| \|
		\| \| expansion. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| cfl \| CFL constraint (dt < cfl * dx / u) \| Real \| See note \|
		\| \| \| \| \|
		\| \| * Defaults to 0.5 if ``mfix.advection_type = MOL`` \| \| \|
		\| \| * Defaults to 0.9 if ``mfix.advection_type = Godunov`` \| \| \|
		\| \| * Ignored if ``mfix.fixed_dt > 0`` \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribution_type \| Algorithms to address the 'small cell problem' associated with \| String \| StateRedist \|
		\| \| explicit cut-cell algorithms. \| \| \|
		\| \| \| \| \|
		@@ -93,26 +93,29 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| * ``StateRedist`` :cite:p:`berger21,giuliani22` \| \| \|
		\| \| * ``FluxRedist`` :cite:p:`chern87,colella06` \| \| \|
		\| \| * ``NoRedist`` - Do not redistribute fluxes. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribute_before_nodal_proj \| Redistribute the velocity field before the nodal projection. \| Bool \| true \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribute_nodal_proj \| Redistribute the velocity field after the nodal projection. \| Bool \| false \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribute_after_initial_nodal_proj\| Apply the selected redistribution algorithm to small cells if doing an \| Bool \| true \|
		\| \| initial projection of the velocity field. \| \| \|
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| correction_small_volfrac \| Threshold volume fraction for correcting small cell velocity \| \| \|
		\| \| at the end of the predictor and corrector. \| Real \| 1.e-4 \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_include_diff_in_forcing \| When using Godunov, include viscous/diffusive terms in forcing terms. \| Bool \| true \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_use_ppm \| When using Godunov, use piecewise parabolic (PPM) instead of \| Bool \| false \|
		\| \| piecewise linear (PLM) reconstruction. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_use_forces_in_trans \| When using Godunov, add forcing terms in the construction of \| Bool \| false \|
		\| \| transverse velocities. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_use_mac_phi \| When using Godunov, don't include the pressure gradient in the \| Bool \| false \|
		\| \| forcing term passed into the Godunov routine; instead use gradient of \| \| \|
		\| \| mac phi which contains the full pressure. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+

		.. note::
		The thermodynamic pressure is a scalar value, not a scalar field. This is a consequence of

Original line number	Diff line number	Diff line
		@@ -73,28 +73,28 @@ 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 the prefix ``mfix`` and control load balancing:
		The following inputs must be preceded by the prefix ``mfix.load_balance`` and control load balancing:

		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| \| Description \| Type \| Default \|
		+==================================+=======================================================================+=============+===================+
		\| \| Grid type. \| String \| SingleGrid \|
		\| grid_type \| Grid type. \| String \| SingleGrid \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		\| load_balance \| * ``SingleGrid`` - fluid and particles are co-located on the same grid\| \| \|
		\| \| * ``SingleGrid`` - fluid and particles are co-located on the same grid\| \| \|
		\| \| * ``DualGrid`` - fluid and particles occupy different grids \| \| \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| load_balance.DualGrid.fluid \| Regrid mesh (fluid) in addition to particles when using `DualGrid` \| Int \| 0 \|
		\| DualGrid.fluid \| Regrid mesh (fluid) in addition to particles when using `DualGrid` \| Int \| 0 \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| load_balance.strategy \| Strategy to use for dynamic load balancing. \| String \| KnapSack \|
		\| strategy \| Strategy to use for dynamic load balancing. \| String \| KnapSack \|
		\| \| \| \| \|
		\| \| Options (case-insensitive): \| \| \|
		\| \| \| \| \|
		\| \| * ``KnapSack`` \| \| \|
		\| \| * ``SFC`` \| \| \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| load_balance.weighting \| Weighting function to use if using ``KnapSack`` load balancing \| String \| ParticleRunTime \|
		\| weighting \| Weighting function to use if using ``KnapSack`` load balancing \| String \| ParticleRunTime \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		\| \| \| \| \|
		@@ -102,7 +102,7 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba
		\| \| * ``ParticleCount`` \| \| \|
		\| \| * ``CellCount`` \| \| \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+
		\| knapsack_nmax \| Maximum number of grids per MPI process if using knapsack algorithm \| Int \| 128 \|
		\| knapsack.nmax \| Maximum number of grids per MPI process if using knapsack algorithm \| Int \| 128 \|
		+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+


		@@ -120,3 +120,11 @@ The following inputs are defined using the prefix ``particles``:
		\| max_grid_size_z \| Maximum number of cells at level 0 in each grid in z-direction \| Int \| 32 \|
		\| \| for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.\| \| \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+

		The following input is defined using the prefix ``eb2``:

		+----------------------+-----------------------------------------------------------------------+-------------+--------------+
		\| \| Description \| Type \| Default \|
		+======================+=======================================================================+=============+==============+
		\| max_grid_size \| Specifies the maximum grid size in AMReX's internal EB database. \| Int \| 64 \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+

Original line number	Diff line number	Diff line
		@@ -38,9 +38,9 @@ Fluid options

		The following inputs are defined using the prefix ``mfix``:

		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| \| Description \| Type \| Default \|
		+=================================+============================================================================+=============+=====================+
		+======================================+============================================================================+=============+=====================+
		\| constraint \| Select low Mach number constraint. \| String \| IncompressibleFluid \|
		\| \| \| \| \|
		\| \| Options (case-insensitive): \| \| \|
		@@ -59,14 +59,14 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| The thermodynamic pressure evolves in time to balance processes like \| \| \|
		\| \| chemical reactions. \| \| \|
		\| \| \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| thermodynamic_pressure \| Thermodynamic pressure. \| Real \| 0 \|
		\| \| A value is required when using the \| \| \|
		\| \| ``IdealGasClosedSystem`` constraint. If using the \| \| \|
		\| \| ``IdealGasOpenSystem`` constraint, if a value is provided then it must \| \| \|
		\| \| match all specified outflow pressures. \| \| \|
		\| \| \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| advection_type \| Advection scheme. \| String \| Godunov \|
		\| \| \| \| \|
		\| \| Options: \| \| \|
		@@ -78,13 +78,13 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| * ``Godunov`` - Godunov. MAC velocities and edge states are \| \| \|
		\| \| extrapolated in space and time using a second-order Taylor series \| \| \|
		\| \| expansion. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| cfl \| CFL constraint (dt < cfl * dx / u) \| Real \| See note \|
		\| \| \| \| \|
		\| \| * Defaults to 0.5 if ``mfix.advection_type = MOL`` \| \| \|
		\| \| * Defaults to 0.9 if ``mfix.advection_type = Godunov`` \| \| \|
		\| \| * Ignored if ``mfix.fixed_dt > 0`` \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribution_type \| Algorithms to address the 'small cell problem' associated with \| String \| StateRedist \|
		\| \| explicit cut-cell algorithms. \| \| \|
		\| \| \| \| \|
		@@ -93,26 +93,29 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| * ``StateRedist`` :cite:p:`berger21,giuliani22` \| \| \|
		\| \| * ``FluxRedist`` :cite:p:`chern87,colella06` \| \| \|
		\| \| * ``NoRedist`` - Do not redistribute fluxes. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribute_before_nodal_proj \| Redistribute the velocity field before the nodal projection. \| Bool \| true \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribute_nodal_proj \| Redistribute the velocity field after the nodal projection. \| Bool \| false \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| redistribute_after_initial_nodal_proj\| Apply the selected redistribution algorithm to small cells if doing an \| Bool \| true \|
		\| \| initial projection of the velocity field. \| \| \|
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| correction_small_volfrac \| Threshold volume fraction for correcting small cell velocity \| \| \|
		\| \| at the end of the predictor and corrector. \| Real \| 1.e-4 \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_include_diff_in_forcing \| When using Godunov, include viscous/diffusive terms in forcing terms. \| Bool \| true \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_use_ppm \| When using Godunov, use piecewise parabolic (PPM) instead of \| Bool \| false \|
		\| \| piecewise linear (PLM) reconstruction. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_use_forces_in_trans \| When using Godunov, add forcing terms in the construction of \| Bool \| false \|
		\| \| transverse velocities. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		\| godunov_use_mac_phi \| When using Godunov, don't include the pressure gradient in the \| Bool \| false \|
		\| \| forcing term passed into the Godunov routine; instead use gradient of \| \| \|
		\| \| mac phi which contains the full pressure. \| \| \|
		+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+
		+--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+

		.. note::
		The thermodynamic pressure is a scalar value, not a scalar field. This is a consequence of

add all keys from benchmarks, tutorials, tests

Merge request reports