Loading docs/source_docs/user_guide/inputs/advanced.rst +3 −3 Original line number Diff line number Diff line Loading @@ -79,14 +79,14 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | | | | | | Options (case-insensitive): | | | | | | | | | | * ``KnapSack`` - FIXME | | | | | * ``SFC`` - FIXME | | | | | * ``KnapSack`` | | | | | * ``SFC`` | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.weighting | Weighting function to use if using ``KnapSack`` load balancing | String | ParticleRunTime | | | | | | | | Options: | | | | | | | | | | * ``ParticleRunTime`` - FIXME | | | | | * ``ParticleRunTime`` | | | | | * ``ParticleCount`` | | | | | * ``CellCount`` | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading docs/source_docs/user_guide/inputs/boundary_conditions.rst +1 −2 Original line number Diff line number Diff line Loading @@ -185,8 +185,7 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | [Optional] When specified, only cells with EB face normal that is | Reals | 0 0 0 | | | parallel and opposite in direction to the specified values | | | | | are imposed with the inflow velocity. FIXME what does OPTIONAL mean | | | | | with a default value of 0? | | | | | are imposed with the inflow velocity. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal_tol | [Optional] Used in conjunction with `eb.normal`. It determines the | Real | 0 | | | tolerance (in degrees) for choosing cells with a specific normal. | | | Loading docs/source_docs/user_guide/inputs/fluid_model.rst +2 −2 Original line number Diff line number Diff line Loading @@ -53,7 +53,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | |mix_Eq| | | | | | | | | | | A viscosity model is required if the fluid solver is | | | | | enabled. FIXME NEED A DEFAULT | | | | | enabled. | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.molecular.constant | Constant fluid viscosity. | Real | 0 | | | | | | Loading Loading @@ -83,7 +83,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | * ``None`` - No eddy viscosity model | | | | | * ``Smagorinsky-Lilly`` :cite:p:`Smag63,Lilly66` | | | | | * ``WALE`` :cite:p:`ducros98` | | | | | * ``usr`` -- FIXME | | | | | * ``usr`` | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.eddy.Smagorinsky-Lilly.constant | Smagorinsky-Lilly constant which usually has values | Real | None | | | between 0.1 and 0.2. | | | Loading docs/source_docs/user_guide/inputs/initial_conditions.rst +2 −2 Original line number Diff line number Diff line Loading @@ -17,7 +17,7 @@ The following inputs are defined using the prefix ``ic``: | | Options: | | | | | | | | | | * ``Inputs`` - preserve order in inputs file | | | | | * ``Volume`` - sort by volume of each IC region FIXME small to large? | | | | | * ``Volume`` - sort by volume of each IC region | | | | | * ``Priority`` - sort by specified priority value | | | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -70,7 +70,7 @@ using the compound prefix ``ic.[region]``: | | (NOTE: ``oneper`` is equivalent to ``1-cube`` and ``eightper`` | | | | | to ``2-cube``) | | | +----------------------+------------------------------------------------------------------+-------------+-----------+ | priority | Priority value for IC regions ranking as described above | Int | Max FIXME | | priority | Priority value for IC regions ranking as described above | Int | Max | +----------------------+------------------------------------------------------------------+-------------+-----------+ For each initial condition region, the solid inputs are defined Loading docs/source_docs/user_guide/inputs/multigrid_solvers.rst +23 −23 Original line number Diff line number Diff line Loading @@ -31,12 +31,12 @@ The following inputs are defined using the prefix ``nodal_proj``: | | | | | | | Options: | | | | | | | | | | * ``bicgcg`` - FIXME | | | | | * ``bicgstab`` - FIXME | | | | | * ``cg`` - FIXME | | | | | * ``cgbicg`` - FIXME | | | | | * ``hypre`` - FIXME | | | | | * ``smoother`` - FIXME | | | | | * ``bicgcg`` | | | | | * ``bicgstab`` | | | | | * ``cg`` | | | | | * ``cgbicg`` | | | | | * ``hypre`` | | | | | * ``smoother`` | | | | | | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | hypre_namespace | Namespace to use in the nodal projection when using hypre | String | hypre | Loading @@ -47,9 +47,9 @@ The following inputs are defined using the prefix ``nodal_proj``: | | | | | | | Options: | | | | | | | | | | * ``ij`` - FIXME | | | | | * ``semi-structured`` - FIXME | | | | | * ``structured`` - FIXME | | | | | * ``ij`` | | | | | * ``semi-structured`` | | | | | * ``structured`` | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading @@ -81,12 +81,12 @@ The following inputs are defined using the prefix ``mac_proj``: | | | | | | | Options: | | | | | | | | | | * ``bicgcg`` - FIXME | | | | | * ``bicgstab`` - FIXME | | | | | * ``cg`` - FIXME | | | | | * ``cgbicg`` - FIXME | | | | | * ``hypre`` - FIXME | | | | | * ``smoother`` - FIXME | | | | | * ``bicgcg`` | | | | | * ``bicgstab`` | | | | | * ``cg`` | | | | | * ``cgbicg`` | | | | | * ``hypre`` | | | | | * ``smoother`` | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | hypre_namespace | Namespace to use in the MAC projection when using ``hypre`` | String | hypre | | | to control hypre specific settings. It can be any string. | | | Loading @@ -95,9 +95,9 @@ The following inputs are defined using the prefix ``mac_proj``: | | | | | | | Options: | | | | | | | | | | * ``ij`` - FIXME | | | | | * ``semi-structured`` - FIXME | | | | | * ``structured`` - FIXME | | | | | * ``ij`` | | | | | * ``semi-structured`` | | | | | * ``structured`` | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading @@ -130,7 +130,7 @@ The following inputs are defined using the prefix ``diffusion``: | | | | | | | Options: | | | | | | | | | | * ``bicgcg`` - FIXME | | | | | * ``bicgcg`` | | | | | * ``cg`` - | | | | | * ``cgbicg`` - | | | | | * ``smoother`` - | | | Loading @@ -154,7 +154,7 @@ a ``hpyre_namespace`` for each solver. * These inputs are all case-sensitive. These inputs follow the typical approach for using `hypre` in MFIX-Exa where `BoomerAMG` is employed as a preconditioner and `GMRES` for the linear solver. FIXME UNCLEAR and `GMRES` for the linear solver. +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | Loading @@ -164,8 +164,8 @@ and `GMRES` for the linear solver. FIXME UNCLEAR | | Options: | | | | | | | | | | * ``none`` - no preconditioner | | | | | * ``BoomerAMG`` - FIXME | | | | | * ``euclid`` - FIXME | | | | | * ``BoomerAMG`` | | | | | * ``euclid`` | | | +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | recompute_preconditioner | Recompute preconditioner during runs | Bool | true | +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading @@ -173,7 +173,7 @@ and `GMRES` for the linear solver. FIXME UNCLEAR | | | | | | | Options: | | | | | | | | | | * ``BoomerAMG`` - FIXME DESC | | | | | * ``BoomerAMG`` | | | | | * ``GMRES`` | | | | | * ``COGMRES`` | | | | | * ``LGMRES`` | | | Loading Loading
docs/source_docs/user_guide/inputs/advanced.rst +3 −3 Original line number Diff line number Diff line Loading @@ -79,14 +79,14 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | | | | | | Options (case-insensitive): | | | | | | | | | | * ``KnapSack`` - FIXME | | | | | * ``SFC`` - FIXME | | | | | * ``KnapSack`` | | | | | * ``SFC`` | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | load_balance.weighting | Weighting function to use if using ``KnapSack`` load balancing | String | ParticleRunTime | | | | | | | | Options: | | | | | | | | | | * ``ParticleRunTime`` - FIXME | | | | | * ``ParticleRunTime`` | | | | | * ``ParticleCount`` | | | | | * ``CellCount`` | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading
docs/source_docs/user_guide/inputs/boundary_conditions.rst +1 −2 Original line number Diff line number Diff line Loading @@ -185,8 +185,7 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | [Optional] When specified, only cells with EB face normal that is | Reals | 0 0 0 | | | parallel and opposite in direction to the specified values | | | | | are imposed with the inflow velocity. FIXME what does OPTIONAL mean | | | | | with a default value of 0? | | | | | are imposed with the inflow velocity. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal_tol | [Optional] Used in conjunction with `eb.normal`. It determines the | Real | 0 | | | tolerance (in degrees) for choosing cells with a specific normal. | | | Loading
docs/source_docs/user_guide/inputs/fluid_model.rst +2 −2 Original line number Diff line number Diff line Loading @@ -53,7 +53,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | |mix_Eq| | | | | | | | | | | A viscosity model is required if the fluid solver is | | | | | enabled. FIXME NEED A DEFAULT | | | | | enabled. | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.molecular.constant | Constant fluid viscosity. | Real | 0 | | | | | | Loading Loading @@ -83,7 +83,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | * ``None`` - No eddy viscosity model | | | | | * ``Smagorinsky-Lilly`` :cite:p:`Smag63,Lilly66` | | | | | * ``WALE`` :cite:p:`ducros98` | | | | | * ``usr`` -- FIXME | | | | | * ``usr`` | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.eddy.Smagorinsky-Lilly.constant | Smagorinsky-Lilly constant which usually has values | Real | None | | | between 0.1 and 0.2. | | | Loading
docs/source_docs/user_guide/inputs/initial_conditions.rst +2 −2 Original line number Diff line number Diff line Loading @@ -17,7 +17,7 @@ The following inputs are defined using the prefix ``ic``: | | Options: | | | | | | | | | | * ``Inputs`` - preserve order in inputs file | | | | | * ``Volume`` - sort by volume of each IC region FIXME small to large? | | | | | * ``Volume`` - sort by volume of each IC region | | | | | * ``Priority`` - sort by specified priority value | | | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -70,7 +70,7 @@ using the compound prefix ``ic.[region]``: | | (NOTE: ``oneper`` is equivalent to ``1-cube`` and ``eightper`` | | | | | to ``2-cube``) | | | +----------------------+------------------------------------------------------------------+-------------+-----------+ | priority | Priority value for IC regions ranking as described above | Int | Max FIXME | | priority | Priority value for IC regions ranking as described above | Int | Max | +----------------------+------------------------------------------------------------------+-------------+-----------+ For each initial condition region, the solid inputs are defined Loading
docs/source_docs/user_guide/inputs/multigrid_solvers.rst +23 −23 Original line number Diff line number Diff line Loading @@ -31,12 +31,12 @@ The following inputs are defined using the prefix ``nodal_proj``: | | | | | | | Options: | | | | | | | | | | * ``bicgcg`` - FIXME | | | | | * ``bicgstab`` - FIXME | | | | | * ``cg`` - FIXME | | | | | * ``cgbicg`` - FIXME | | | | | * ``hypre`` - FIXME | | | | | * ``smoother`` - FIXME | | | | | * ``bicgcg`` | | | | | * ``bicgstab`` | | | | | * ``cg`` | | | | | * ``cgbicg`` | | | | | * ``hypre`` | | | | | * ``smoother`` | | | | | | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | hypre_namespace | Namespace to use in the nodal projection when using hypre | String | hypre | Loading @@ -47,9 +47,9 @@ The following inputs are defined using the prefix ``nodal_proj``: | | | | | | | Options: | | | | | | | | | | * ``ij`` - FIXME | | | | | * ``semi-structured`` - FIXME | | | | | * ``structured`` - FIXME | | | | | * ``ij`` | | | | | * ``semi-structured`` | | | | | * ``structured`` | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading @@ -81,12 +81,12 @@ The following inputs are defined using the prefix ``mac_proj``: | | | | | | | Options: | | | | | | | | | | * ``bicgcg`` - FIXME | | | | | * ``bicgstab`` - FIXME | | | | | * ``cg`` - FIXME | | | | | * ``cgbicg`` - FIXME | | | | | * ``hypre`` - FIXME | | | | | * ``smoother`` - FIXME | | | | | * ``bicgcg`` | | | | | * ``bicgstab`` | | | | | * ``cg`` | | | | | * ``cgbicg`` | | | | | * ``hypre`` | | | | | * ``smoother`` | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ | hypre_namespace | Namespace to use in the MAC projection when using ``hypre`` | String | hypre | | | to control hypre specific settings. It can be any string. | | | Loading @@ -95,9 +95,9 @@ The following inputs are defined using the prefix ``mac_proj``: | | | | | | | Options: | | | | | | | | | | * ``ij`` - FIXME | | | | | * ``semi-structured`` - FIXME | | | | | * ``structured`` - FIXME | | | | | * ``ij`` | | | | | * ``semi-structured`` | | | | | * ``structured`` | | | +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading @@ -130,7 +130,7 @@ The following inputs are defined using the prefix ``diffusion``: | | | | | | | Options: | | | | | | | | | | * ``bicgcg`` - FIXME | | | | | * ``bicgcg`` | | | | | * ``cg`` - | | | | | * ``cgbicg`` - | | | | | * ``smoother`` - | | | Loading @@ -154,7 +154,7 @@ a ``hpyre_namespace`` for each solver. * These inputs are all case-sensitive. These inputs follow the typical approach for using `hypre` in MFIX-Exa where `BoomerAMG` is employed as a preconditioner and `GMRES` for the linear solver. FIXME UNCLEAR and `GMRES` for the linear solver. +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | Loading @@ -164,8 +164,8 @@ and `GMRES` for the linear solver. FIXME UNCLEAR | | Options: | | | | | | | | | | * ``none`` - no preconditioner | | | | | * ``BoomerAMG`` - FIXME | | | | | * ``euclid`` - FIXME | | | | | * ``BoomerAMG`` | | | | | * ``euclid`` | | | +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | recompute_preconditioner | Recompute preconditioner during runs | Bool | true | +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading @@ -173,7 +173,7 @@ and `GMRES` for the linear solver. FIXME UNCLEAR | | | | | | | Options: | | | | | | | | | | * ``BoomerAMG`` - FIXME DESC | | | | | * ``BoomerAMG`` | | | | | * ``GMRES`` | | | | | * ``COGMRES`` | | | | | * ``LGMRES`` | | | Loading
