Loading docs/source_docs/user_guide/inputs/advanced.rst +5 −5 Original line number Diff line number Diff line Loading @@ -70,8 +70,8 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | | | | | | Options: | | | | | | | | | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | | | | | * ``DualGrid`` fluid and particles live on different grids | | | | load_balance | * ``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 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading Loading @@ -107,11 +107,11 @@ The following inputs are defined using the prefix ``particles``: | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | max_grid_size_x | Maximum number of cells at level 0 in each grid in x-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_grid_size_y | Maximum number of cells at level 0 in each grid in y-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | 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 dual_grid is true. | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ docs/source_docs/user_guide/inputs/boundary_conditions.rst +5 −5 Original line number Diff line number Diff line Loading @@ -12,7 +12,7 @@ The following inputs are defined using the prefix ``bc``: +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. | String | None | | regions | Regions used to define boundary conditions. | Strings | None | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading Loading @@ -68,7 +68,7 @@ using the prefix ``bc.[region].[fluid]``: | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species0] | Species 'species0' mass fraction [required if solve_species=1 | Real | 0 | | species.[species_name] | Species 'species_name' mass fraction [required if solve_species=1 | Real | 0 | | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -135,7 +135,7 @@ tridimensional). We recall that, on the remaining part of the EBs, homogeneous Neumann boundary conditions are assumed by default. In the following table there is a list of the possible entries for EB boundary conditions. Each entry must be preceded by `bc.[region0].` conditions. Each entry must be preceded by the prefix ``bc.[region]`` +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -158,8 +158,8 @@ In addition to the temperature, it is possible to set an inflow condition for fl on an embedeed boundary. We recall that, on the remaining part of the EBs, no slip velocity conditions are assumed by default. In the following table there is a list of the possible entries for inflow EB boundary conditions. Each entry must be preceded by `bc.[region0].` Like traditional mass In the following table is a list of the possible entries for inflow EB boundary conditions. Each entry must be preceded by the prefix ``bc.[region]``. Like traditional mass inflows, the fluid temperature, pressure, and species composition must be provided when appropriate. Loading docs/source_docs/user_guide/inputs/chemical_reactions.rst +16 −16 Original line number Diff line number Diff line Loading @@ -8,15 +8,15 @@ The following inputs are defined using the prefix ``chemistry``: +--------------------------+---------------------------------------------------------+----------+----------------+ | | Description | Type | Default | +==========================+=========================================================+==========+================+ | solve | Specify the name(s) of the chemical reactions or set | String | | | solve | Specify the name(s) of the chemical reactions or set | Strings | | | | to None to disable the chemistry solver. The name(s) | | | | | assigned to the chemistry solver are used to specify | | | | | the chemical reactions equations. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | [reaction0].reaction | Chemical formula for the given reaction. The string | String | | | [reaction].reaction | Chemical formula for the given reaction. The string | String | | | | given as input must not contain white space and | | | | | the reaction direction has to be specified as '\-\->' | | | | | or '<\-\-'. Chemical species phases must be defined as | | | | | the reaction direction must be specified as `\-\->` | | | | | or `<\-\-`. Chemical species phases must be defined as | | | | | '(g)' for the fluid phase or '(s)' for the solid phase. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | mass_balance_tolerance | Tolerance used to test chemical formula conserves mass. | Real | 1e-12 | Loading @@ -32,20 +32,20 @@ The following inputs are defined using the prefix ``chemistry``: | | * ``ConstantVolume`` - keep particle volume constant | | | | | * ``ConstantDensity`` - keep particle density constant | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.mass_threshold | Sets a threshold value for the particles' mass. When | Real | 0 | | | updating the solids quantities in chemistry, check | | | | | whether the solids mass is below the threshold, and in | | | | | that case set the particle as invalid and remove it. | | | | solids.mass_threshold | Threshold value for the particle mass. When | Real | 0 | | | updating the solids quantities in chemistry, if | | | | | the particle solids mass is below the threshold, | | | | | the particle is marked as invalid and removed. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.radius_threshold | Sets a threshold value for the particles' radius. When | Real | 0 | | | updating the solids quantities in chemistry, check | | | | | whether the solids radius is below the threshold, and | | | | | in that case set the particle as invalid and remove it. | | | | solids.radius_threshold | Threshold value for the particle radius. When | Real | 0 | | | updating the solids quantities in chemistry, if | | | | | the particle radius is below the threshold, | | | | | the particle is marked as invalid and removed. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.density_threshold | Sets a threshold value for the particles' density. When | Real | 0 | | | updating the solids quantities in chemistry, check | | | | | whether the solids density is below the threshold, and | | | | | in that case set the particle as invalid and remove it. | | | | solids.density_threshold | Threshold value for the particle density. When | Real | 0 | | | updating the solids quantities in chemistry, if | | | | | the solids density is below the threshold, | | | | | the particle is marked as invalid and removed. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ Choosing the integrator type for the chemistry ODE integration operation that is Loading docs/source_docs/user_guide/inputs/fluid_model.rst +2 −2 Original line number Diff line number Diff line Loading @@ -19,7 +19,7 @@ The root prefix for the following inputs is the name defined using the ``fluid.s 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. .. |Sutherland_Eq| replace:: :math:`\mu(T) = \mu_{ref}\left(\frac{T}{T_{ref}}\right)^{3/2}\frac{T_{ref} + S}{T+S}` .. |Sutherland_Eq| replace:: :math:`\mu(T) = \mu_{ref}\left(\frac{T}{T_{ref}}\right)^{3/2}\times\frac{(T_{ref} + S)}{(T+S)}` .. |Reid_4parm_Eq| replace:: :math:`\mu(T) = Ae^{\left(\frac{B}{T} + CT + DT^2 \right)}` Loading Loading @@ -156,7 +156,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | :math:`\mu_{eff} < fac*\mu_{mol}`, where | | | | | |eff_visc| | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | species | Specify the species that constitute the fluid. | String | None | | species | Specify the species that constitute the fluid. | Strings| None | | | | | | | | All listed species must be properly defined. See the | | | | | :ref:`species definition documentation<InputsSpeciesDefs>` | | | Loading docs/source_docs/user_guide/inputs/geometry.rst +7 −7 Original line number Diff line number Diff line Loading @@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===============================================================================+==========+=====================+ | geometry | Specify the simulation geometry. | String | '' | | geometry | Simulation geometry type. | String | '' | | | Options (case-insensitive): | | | | | | | | | | * ``box`` - predefined :ref:`box geometry<InputsGeometry_box>` | | | Loading Loading @@ -153,7 +153,7 @@ The following inputs are defined using the prefix ``cylinder``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===================================================================+==========+=====================+ | radius | Cylinder radius | Real | 0.0002 | | radius | Cylinder radius. | Real | 0.0002 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | height | Height (length) of cylinder. If the height is not defined (-1), | Real | -1 | | | then the cylinder is made infinitely long to overhang the domain | | | Loading @@ -162,7 +162,7 @@ The following inputs are defined using the prefix ``cylinder``: | direction | Axis the cylinder runs along. | Int | 0 | | | (``0``: *X*, ``1``: *Y*, ``2``: *Z*) | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0. 0. 0. | | center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0 0 0 | | | the center value in the height ``direction`` can be any value. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation | Rotation angle in degrees of cylinder. | Real | 0. | Loading Loading @@ -349,9 +349,9 @@ The following inputs are defined using the prefix ``csg``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | internal_flow | Indicates that flow is *inside* the box. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | scaling_factor | Scale the geometry. | Reals | 1. 1. 1. | | scaling_factor | Scale the geometry. | Reals | 1 1 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | translation | Translate the geometry. | Reals | 0. 0. 0. | | translation | Translate the geometry. | Reals | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ .. note:: Loading @@ -373,9 +373,9 @@ The following inputs are defined using the prefix ``stl``: +========================+===================================================================+==========+=====================+ | geometry_filename | The STL file that defines the EB geometry. | String | '' | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | scaling_factor | Scale the geometry. | Real | 1. | | scaling_factor | Scale the geometry. | Real | 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | translation | Translate the geometry. | Reals | 0. 0. 0. | | translation | Translate the geometry. | Reals | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | use_bvh | Use bounding volume optimization. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ Loading Loading
docs/source_docs/user_guide/inputs/advanced.rst +5 −5 Original line number Diff line number Diff line Loading @@ -70,8 +70,8 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | | | | | | Options: | | | | | | | | | load_balance | * ``SingleGrid`` fluid and particles are co-located on the same grids | | | | | * ``DualGrid`` fluid and particles live on different grids | | | | load_balance | * ``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 | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ Loading Loading @@ -107,11 +107,11 @@ The following inputs are defined using the prefix ``particles``: | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | max_grid_size_x | Maximum number of cells at level 0 in each grid in x-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_grid_size_y | Maximum number of cells at level 0 in each grid in y-direction | Int | 32 | | | for grids in the ParticleBoxArray if dual_grid is true | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | 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 dual_grid is true. | | | | | for grids in the ParticleBoxArray if ``load_balance`` is ``DualGrid``.| | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+
docs/source_docs/user_guide/inputs/boundary_conditions.rst +5 −5 Original line number Diff line number Diff line Loading @@ -12,7 +12,7 @@ The following inputs are defined using the prefix ``bc``: +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. | String | None | | regions | Regions used to define boundary conditions. | Strings | None | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading Loading @@ -68,7 +68,7 @@ using the prefix ``bc.[region].[fluid]``: | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species0] | Species 'species0' mass fraction [required if solve_species=1 | Real | 0 | | species.[species_name] | Species 'species_name' mass fraction [required if solve_species=1 | Real | 0 | | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -135,7 +135,7 @@ tridimensional). We recall that, on the remaining part of the EBs, homogeneous Neumann boundary conditions are assumed by default. In the following table there is a list of the possible entries for EB boundary conditions. Each entry must be preceded by `bc.[region0].` conditions. Each entry must be preceded by the prefix ``bc.[region]`` +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -158,8 +158,8 @@ In addition to the temperature, it is possible to set an inflow condition for fl on an embedeed boundary. We recall that, on the remaining part of the EBs, no slip velocity conditions are assumed by default. In the following table there is a list of the possible entries for inflow EB boundary conditions. Each entry must be preceded by `bc.[region0].` Like traditional mass In the following table is a list of the possible entries for inflow EB boundary conditions. Each entry must be preceded by the prefix ``bc.[region]``. Like traditional mass inflows, the fluid temperature, pressure, and species composition must be provided when appropriate. Loading
docs/source_docs/user_guide/inputs/chemical_reactions.rst +16 −16 Original line number Diff line number Diff line Loading @@ -8,15 +8,15 @@ The following inputs are defined using the prefix ``chemistry``: +--------------------------+---------------------------------------------------------+----------+----------------+ | | Description | Type | Default | +==========================+=========================================================+==========+================+ | solve | Specify the name(s) of the chemical reactions or set | String | | | solve | Specify the name(s) of the chemical reactions or set | Strings | | | | to None to disable the chemistry solver. The name(s) | | | | | assigned to the chemistry solver are used to specify | | | | | the chemical reactions equations. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | [reaction0].reaction | Chemical formula for the given reaction. The string | String | | | [reaction].reaction | Chemical formula for the given reaction. The string | String | | | | given as input must not contain white space and | | | | | the reaction direction has to be specified as '\-\->' | | | | | or '<\-\-'. Chemical species phases must be defined as | | | | | the reaction direction must be specified as `\-\->` | | | | | or `<\-\-`. Chemical species phases must be defined as | | | | | '(g)' for the fluid phase or '(s)' for the solid phase. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | mass_balance_tolerance | Tolerance used to test chemical formula conserves mass. | Real | 1e-12 | Loading @@ -32,20 +32,20 @@ The following inputs are defined using the prefix ``chemistry``: | | * ``ConstantVolume`` - keep particle volume constant | | | | | * ``ConstantDensity`` - keep particle density constant | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.mass_threshold | Sets a threshold value for the particles' mass. When | Real | 0 | | | updating the solids quantities in chemistry, check | | | | | whether the solids mass is below the threshold, and in | | | | | that case set the particle as invalid and remove it. | | | | solids.mass_threshold | Threshold value for the particle mass. When | Real | 0 | | | updating the solids quantities in chemistry, if | | | | | the particle solids mass is below the threshold, | | | | | the particle is marked as invalid and removed. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.radius_threshold | Sets a threshold value for the particles' radius. When | Real | 0 | | | updating the solids quantities in chemistry, check | | | | | whether the solids radius is below the threshold, and | | | | | in that case set the particle as invalid and remove it. | | | | solids.radius_threshold | Threshold value for the particle radius. When | Real | 0 | | | updating the solids quantities in chemistry, if | | | | | the particle radius is below the threshold, | | | | | the particle is marked as invalid and removed. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.density_threshold | Sets a threshold value for the particles' density. When | Real | 0 | | | updating the solids quantities in chemistry, check | | | | | whether the solids density is below the threshold, and | | | | | in that case set the particle as invalid and remove it. | | | | solids.density_threshold | Threshold value for the particle density. When | Real | 0 | | | updating the solids quantities in chemistry, if | | | | | the solids density is below the threshold, | | | | | the particle is marked as invalid and removed. | | | +--------------------------+---------------------------------------------------------+----------+----------------+ Choosing the integrator type for the chemistry ODE integration operation that is Loading
docs/source_docs/user_guide/inputs/fluid_model.rst +2 −2 Original line number Diff line number Diff line Loading @@ -19,7 +19,7 @@ The root prefix for the following inputs is the name defined using the ``fluid.s 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. .. |Sutherland_Eq| replace:: :math:`\mu(T) = \mu_{ref}\left(\frac{T}{T_{ref}}\right)^{3/2}\frac{T_{ref} + S}{T+S}` .. |Sutherland_Eq| replace:: :math:`\mu(T) = \mu_{ref}\left(\frac{T}{T_{ref}}\right)^{3/2}\times\frac{(T_{ref} + S)}{(T+S)}` .. |Reid_4parm_Eq| replace:: :math:`\mu(T) = Ae^{\left(\frac{B}{T} + CT + DT^2 \right)}` Loading Loading @@ -156,7 +156,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | :math:`\mu_{eff} < fac*\mu_{mol}`, where | | | | | |eff_visc| | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | species | Specify the species that constitute the fluid. | String | None | | species | Specify the species that constitute the fluid. | Strings| None | | | | | | | | All listed species must be properly defined. See the | | | | | :ref:`species definition documentation<InputsSpeciesDefs>` | | | Loading
docs/source_docs/user_guide/inputs/geometry.rst +7 −7 Original line number Diff line number Diff line Loading @@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===============================================================================+==========+=====================+ | geometry | Specify the simulation geometry. | String | '' | | geometry | Simulation geometry type. | String | '' | | | Options (case-insensitive): | | | | | | | | | | * ``box`` - predefined :ref:`box geometry<InputsGeometry_box>` | | | Loading Loading @@ -153,7 +153,7 @@ The following inputs are defined using the prefix ``cylinder``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===================================================================+==========+=====================+ | radius | Cylinder radius | Real | 0.0002 | | radius | Cylinder radius. | Real | 0.0002 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | height | Height (length) of cylinder. If the height is not defined (-1), | Real | -1 | | | then the cylinder is made infinitely long to overhang the domain | | | Loading @@ -162,7 +162,7 @@ The following inputs are defined using the prefix ``cylinder``: | direction | Axis the cylinder runs along. | Int | 0 | | | (``0``: *X*, ``1``: *Y*, ``2``: *Z*) | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0. 0. 0. | | center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0 0 0 | | | the center value in the height ``direction`` can be any value. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation | Rotation angle in degrees of cylinder. | Real | 0. | Loading Loading @@ -349,9 +349,9 @@ The following inputs are defined using the prefix ``csg``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | internal_flow | Indicates that flow is *inside* the box. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | scaling_factor | Scale the geometry. | Reals | 1. 1. 1. | | scaling_factor | Scale the geometry. | Reals | 1 1 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | translation | Translate the geometry. | Reals | 0. 0. 0. | | translation | Translate the geometry. | Reals | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ .. note:: Loading @@ -373,9 +373,9 @@ The following inputs are defined using the prefix ``stl``: +========================+===================================================================+==========+=====================+ | geometry_filename | The STL file that defines the EB geometry. | String | '' | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | scaling_factor | Scale the geometry. | Real | 1. | | scaling_factor | Scale the geometry. | Real | 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | translation | Translate the geometry. | Reals | 0. 0. 0. | | translation | Translate the geometry. | Reals | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | use_bvh | Use bounding volume optimization. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ Loading
