From cb5e370390d361d2e71f07423eeeb87824c335e2 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Wed, 4 Mar 2026 10:25:57 -0600 Subject: [PATCH] add all keys from benchmarks, tutorials, tests --- .../references/size_distributions.rst | 2 +- .../qualitative_bencharks/biseg.rst | 2 +- .../user_guide/inputs/advanced.rst | 22 ++- .../user_guide/inputs/model_options.rst | 153 +++++++++--------- 4 files changed, 95 insertions(+), 84 deletions(-) diff --git a/docs/source_docs/references/size_distributions.rst b/docs/source_docs/references/size_distributions.rst index 058a049..517a0e1 100644 --- a/docs/source_docs/references/size_distributions.rst +++ b/docs/source_docs/references/size_distributions.rst @@ -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` diff --git a/docs/source_docs/test_benchmarks/qualitative_bencharks/biseg.rst b/docs/source_docs/test_benchmarks/qualitative_bencharks/biseg.rst index fd0fa0c..d0544d6 100644 --- a/docs/source_docs/test_benchmarks/qualitative_bencharks/biseg.rst +++ b/docs/source_docs/test_benchmarks/qualitative_bencharks/biseg.rst @@ -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. diff --git a/docs/source_docs/user_guide/inputs/advanced.rst b/docs/source_docs/user_guide/inputs/advanced.rst index d243a99..56dc646 100644 --- a/docs/source_docs/user_guide/inputs/advanced.rst +++ b/docs/source_docs/user_guide/inputs/advanced.rst @@ -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 | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index c821d94..55526df 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -38,81 +38,84 @@ 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): | | | -| | | | | -| | * ``IncompressibleFluid`` constraint is appropriate for cold flow systems | | | -| | that do not have chemical reactions. Fluid temperature and species mass | | | -| | fractions act as passive tracers if advected. | | | -| | | | | -| | * ``IdealGasOpenSystem`` constraint is used if the physical domain | | | -| | contains at least one pressure outflow boundary condition. The specified | | | -| | outflow (ambient) pressure is maintained so that the thermodynamic | | | -| | pressure is constant. | | | -| | | | | -| | * ``IdealGasClosedSystem`` constraint is used for systems that are fully | | | -| | periodic or completely closed with no inflow / outflow boundaries. | | | -| | 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: | | | -| | | | | -| | * ``MOL``- Predictor-Corrector Method of Lines. MAC | | | -| | (Marker-and-Cell) velocities and edge states are extrapolated in | | | -| | space. | | | -| | | | | -| | * ``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. | | | -| | | | | -| | Options: | | | -| | | | | -| | * ``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 | -+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+ -| 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. | | | -+---------------------------------+----------------------------------------------------------------------------+-------------+---------------------+ ++--------------------------------------+----------------------------------------------------------------------------+-------------+---------------------+ +| | Description | Type | Default | ++======================================+============================================================================+=============+=====================+ +| constraint | Select low Mach number constraint. | String | IncompressibleFluid | +| | | | | +| | Options (case-insensitive): | | | +| | | | | +| | * ``IncompressibleFluid`` constraint is appropriate for cold flow systems | | | +| | that do not have chemical reactions. Fluid temperature and species mass | | | +| | fractions act as passive tracers if advected. | | | +| | | | | +| | * ``IdealGasOpenSystem`` constraint is used if the physical domain | | | +| | contains at least one pressure outflow boundary condition. The specified | | | +| | outflow (ambient) pressure is maintained so that the thermodynamic | | | +| | pressure is constant. | | | +| | | | | +| | * ``IdealGasClosedSystem`` constraint is used for systems that are fully | | | +| | periodic or completely closed with no inflow / outflow boundaries. | | | +| | 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: | | | +| | | | | +| | * ``MOL``- Predictor-Corrector Method of Lines. MAC | | | +| | (Marker-and-Cell) velocities and edge states are extrapolated in | | | +| | space. | | | +| | | | | +| | * ``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. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``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 -- GitLab