diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 77d5e13433e7bfdcb386d4286f03baf2bcc827ac..9bbda17cbdf273084422c42382a000e776f06ab7 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -17,18 +17,6 @@ The following inputs are defined using the prefix ``bc``: | | and ``disk``. Embedded boundary (EB) regions support ``box``, | | | | | ``cylinder``, and ``sphere`` shapes. | | | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ -| delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | -| | should also be periodic. | | | -| | | | | -| | Options: | | | -| | * ``0``: X | | | -| | * ``1``: Y | | | -| | * ``2``: Z | | | -+---------------------+--------------------------------------------------------------------------+-------------+-----------+ -| delp | Pressure drop (Pa) | Real | 0 | -+---------------------+--------------------------------------------------------------------------+-------------+-----------+ -| po_no_par_out | Force particles to bounce back rather than exiting at pressure outflows. | Int | 0 | -+---------------------+--------------------------------------------------------------------------+-------------+-----------+ The type of the boundary conditions in the BC region must be defined with the prefix ``bc``: @@ -59,24 +47,24 @@ using the prefix ``bc.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+========================================================================+=============+===========+ -| volfrac | Volume fraction [required if bc type is ``mi``] | Real | 0 | +| volfrac | Volume fraction [required if bc type is ``mi``] | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| density | Fluid density [required if bc type is ``mi`` or ``pi``] | Real | 0 | +| density | Fluid density [required if bc type is ``mi`` or ``pi``] | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| pressure | Fluid pressure [required if bc type is ``po' or ``pi``] | Real | 0 | +| pressure | Fluid pressure [required if bc type is ``po' or ``pi``] | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| temperature | Fluid temperature [required if bc type is ``mi`` or ``pi``] | Real | 0 | +| temperature | Fluid temperature [required if bc type is ``mi`` or ``pi``] | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components [required if bc type is ``mi`` | Reals<3> | 0 0 0 | +| velocity | Velocity components [required if bc type is ``mi`` | Reals | None | | | and ``volflow`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| volflow | Volumetric flow rate [required if bc type is ``mi`` | Real | 0 | +| volflow | Volumetric flow rate [required if bc type is ``mi`` | Real | None | | | and ``velocity`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| massflow | Mass flow rate [required if bc type is ``mi`` | Real | 0 | +| massflow | Mass flow rate [required if bc type is ``mi`` | Real | None | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| species.[species_name] | Species `species_name` mass fraction [required if `solve_species`=1 | Real | 0 | +| species.[species_name] | Species `species_name` mass fraction [required if `solve_species`=1 | Real | None | | | and bc type is ``mi`` or ``pi``] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ @@ -154,15 +142,15 @@ For inflow boundary conditions , the solids inputs are defined using the prefix +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+=======================================================================+=============+===========+ -| volfrac | Volume fraction | Real | 0 | +| volfrac | Volume fraction | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| temperature | Temperature | Real | 0 | +| temperature | Temperature | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| species.[species_name] | Mass fraction of ``species_name`` | Real | 0 | +| species.[species_name] | Mass fraction of ``species_name`` | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components | Reals<3> | 0 0 0 | +| velocity | Velocity components | Reals | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| volflow | Volumetric flow rate. | Real | 0 | +| volflow | Volumetric flow rate. | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -199,20 +187,20 @@ please refer to :ref:`ReferenceParticleDistributions | 0 0 0 | +| normal | [Optional] Specifies the target face normal direction. Only EB faces | Reals<3> | None | | | whose normals are parallel (within the specified tolerance) will have | | | | | the boundary condition applied. | | | +--------------------+-----------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/domain.rst b/docs/source_docs/user_guide/inputs/domain.rst index 5b41cc9a3ea3d052c8d7e7672f467b94b7f4df85..5c5b14884eaad1d9be1b5fc62e9310e976230ce4 100644 --- a/docs/source_docs/user_guide/inputs/domain.rst +++ b/docs/source_docs/user_guide/inputs/domain.rst @@ -18,9 +18,9 @@ The following inputs are defined using the prefix ``geometry``: +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ -| prob_lo | Low corner of physical domain (physical not index space) | Reals<3> | 0 0 0 | +| prob_lo | Low corner of physical domain (physical not index space) | Reals<3> | None | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ -| prob_hi | High corner of physical domain (physical not index space) | Reals<3> | 0 0 0 | +| prob_hi | High corner of physical domain (physical not index space) | Reals<3> | None | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ .. attention:: @@ -30,6 +30,7 @@ The following inputs are defined using the prefix ``geometry``: * There is **no support** for 1D or 2D simulation domains. * Cartesian is the **only supported** coordinate system. +---- Mesh ---- @@ -42,7 +43,7 @@ The following inputs are defined using the prefix ``amr``: | | Description | Type | Default | | | | | | +======================+=======================================================================+=============+===========+ -| n_cell | Number of cells at level 0 in each coordinate direction. | Ints<3> | 0 0 0 | +| n_cell | Number of cells at level 0 in each coordinate direction. | Ints<3> | None | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The base mesh spacing is computed for each direction by dividing the :ref:`domain length` by the @@ -90,3 +91,21 @@ The result is a uniform mesh spacing of :math:`0.125` *m* in all three direction .. warning:: MFIX-Exa simulations with a non-uniform mesh will not run. + +---- + +The following inputs are defined using the prefix ``mfix``: + ++--------------------------+----------------------------------------------------------------------------+----------+---------+ +| | Description | Type | Default | ++==========================+============================================================================+==========+=========+ +| delp_dir | Direction for specified pressure drop. The domain must be periodic in the | Int | None | +| | the specified direction. | | | +| | | | | +| | Options: | | | +| | * ``0``: X | | | +| | * ``1``: Y | | | +| | * ``2``: Z | | | ++--------------------------+----------------------------------------------------------------------------+----------+---------+ +| delp | Pressure drop (Pa) | Real | 0 | ++--------------------------+----------------------------------------------------------------------------+----------+---------+ diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 42d25438fad0dde4edec7b840df76c6ebce59318..58ceadc721d9209e8895190dfe6b1b9b413050c1 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -50,11 +50,10 @@ The following inputs are defined using the prefix ``[fluid_name].viscosity.molec +------------------------+----------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +========================+================================================================+========+==========+ -| model | Specify which molecular viscosity model to use. | String | None | +| model | Specify which molecular viscosity model to use. | String | constant | | | | | | | | Options: | | | | | | | | -| | * ``None`` - no viscosity model. | | | | | * ``constant`` - constant viscosity | | | | | * ``Sutherland`` :cite:p:`suth1893` - | | | | | | | | @@ -73,23 +72,23 @@ The following inputs are defined using the prefix ``[fluid_name].viscosity.molec | | A viscosity model is required if the fluid solver is | | | | | enabled. | | | +------------------------+----------------------------------------------------------------+--------+----------+ -| constant | Constant fluid viscosity. | Real | 0 | +| constant | Constant fluid viscosity. | Real | None | | | | | | | | A value is required for ``constant`` viscosity model. | | | +------------------------+----------------------------------------------------------------+--------+----------+ -| Sutherland.T_ref | Sutherland model reference temperature. | Real | 0 | +| Sutherland.T_ref | Sutherland model reference temperature. | Real | None | | | | | | | | A value is required for ``Sutherland`` viscosity model. | | | +------------------------+----------------------------------------------------------------+--------+----------+ -| Sutherland.mu_ref | Sutherland model reference viscosity at T_ref. | Real | 0 | +| Sutherland.mu_ref | Sutherland model reference viscosity at T_ref. | Real | None | | | | | | | | A value is required for ``Sutherland`` viscosity model. | | | +------------------------+----------------------------------------------------------------+--------+----------+ -| Sutherland.S | Sutherland model temperature. | Real | 0 | +| Sutherland.S | Sutherland model temperature. | Real | None | | | | | | | | A value is required for ``Sutherland`` viscosity model. | | | +------------------------+----------------------------------------------------------------+--------+----------+ -| Reid.A | Reid model constants. | Real | 0 | +| Reid.A | Reid model constants. | Real | None | | Reid.B | | | | | Reid.C | Values are required for ``Reid`` viscosity model. | | | | Reid.D | | | | diff --git a/docs/source_docs/user_guide/inputs/geometry.rst b/docs/source_docs/user_guide/inputs/geometry.rst index deb7152cd69d2502bee69f3d0085963121254767..e0ad0d894ce5444f798b0af60b14f1c330572042 100644 --- a/docs/source_docs/user_guide/inputs/geometry.rst +++ b/docs/source_docs/user_guide/inputs/geometry.rst @@ -13,6 +13,7 @@ The following inputs are defined using the prefix ``mfix``: | | | | | | | * ``box`` - predefined :ref:`box geometry` | | | | | * ``cylinder`` - predefined :ref:`cylinder geometry` | | | +| | * ``sphere`` - predefined :ref:`sphere geometry` | | | | | * ``generic`` - :ref:`user-defined geometry` | | | | | * ``CSG`` - use :ref:`Constructive Solid Geometry` file | | | | | * ``STL`` - use :ref:`Standard Triangle Language` file | | | @@ -265,6 +266,26 @@ the EB ``cylinder`` are *covered* and thereby excluded from calculations. on the low *X* face and a pressure outflow on the *X* high face. +---- + +.. _InputsGeometry_sphere: + +``sphere`` geometry +^^^^^^^^^^^^^^^^^^^ + +The following inputs are defined using the prefix ``sphere``: + ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| | Description | Type | Default | ++========================+===================================================================+==========+=====================+ +| radius | Sphere radius. | Real | None | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| center | Center of sphere. | Reals<3> | 0 0 0 | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| internal_flow | Indicates that flow is *inside* the sphere. | Bool | false | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ + + ---- .. _InputsGeometry_generic: @@ -300,12 +321,12 @@ The following inputs are defined using the prefix ``csg``: +========================+===================================================================+==========+=====================+ | geometry_filename | The CSG file that defines the EB geometry. | String | '' | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -| internal_flow | Indicates that flow is *inside* the box. | Bool | true | -+------------------------+-------------------------------------------------------------------+----------+---------------------+ | scaling_factor | Scale the geometry. | Reals<3> | 1 1 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | translation | Translate the geometry. | Reals<3> | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ +| internal_flow | Indicates that flow is *inside* the the CSG geometry. | Bool | true | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ .. note:: A full description of this feature is beyond the scope of this section. A future update to @@ -330,6 +351,8 @@ The following inputs are defined using the prefix ``stl``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | translation | Translate the geometry. | Reals<3> | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ +| internal_flow | Indicates that flow is *inside* the STL geometry. | Bool | true | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ | use_bvh | Use bounding volume optimization. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ @@ -338,20 +361,6 @@ The following inputs are defined using the prefix ``stl``: the documentation may include a tutorial to better demonstrate this feature. -Checkpoint geometry -------------------- - -Read EB geometry data from a checkpoint file. - -The following inputs are defined using the prefix ``mfix``. - -+----------------------+-----------------------------------------------------------------------+-------------+--------------+ -| | Description | Type | Default | -+======================+=======================================================================+=============+==============+ -| geom_chk_read | Flag to read the EB geometry data from the ``geom_chk_file`` | Bool | false | -| | :ref:`checkpoint file`. If levelset refinement | | | -| | is enabled, levelset data is read from ``geom_levelset_chk_file``. | | | -+----------------------+-----------------------------------------------------------------------+-------------+--------------+ Levelset refinement ------------------- diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 7c94000bf717e77ecf97406fcc4255cf3dca19f4..7220f9c81b4b5ffd86eae2f31279b89a41a6a1f6 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -26,17 +26,17 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+========================================================================+=============+===========+ -| volfrac | Volume fraction [required] | Real | 0 | +| volfrac | Volume fraction [required] | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| density | Fluid density | Real | 0 | +| density | Fluid density | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components | Reals<3> | 0 0 0 | +| velocity | Velocity components | Reals<3> | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| pressure | Fluid pressure | Real | 0 | +| pressure | Fluid pressure | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| temperature | Fluid temperature | Real | 0 | +| temperature | Fluid temperature | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| species.[species_name] | Mass fraction of ``species_name``. Species must be a fluid species. | Real | 0 | +| species.[species_name] | Mass fraction of ``species_name``. Species must be a fluid species. | Real | None | +------------------------+------------------------------------------------------------------------+-------------+-----------+ @@ -80,13 +80,13 @@ using the compound prefix ``ic.[region_name].[solid_name]``: +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+=======================================================================+=============+===========+ -| volfrac | Volume fraction | Real | 0 | +| volfrac | Volume fraction | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| temperature | Temperature | Real | 0 | +| temperature | Temperature | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| species.[species_name] | Mass fraction of `species_name`. Must be a solid species. | Real | 0 | +| species.[species_name] | Mass fraction of `species_name`. Must be a solid species. | Real | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components | Reals<3> | 0 0 0 | +| velocity | Velocity components | Reals<3> | None | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ For automatically generated particles, diameter and density distributions can be specified. @@ -122,20 +122,20 @@ please refer to :ref:`ReferenceParticleDistributions `. If levelset refinement | | | +| | is enabled, levelset data is read from ``geom_levelset_chk_file``. | | | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index 55526dfa10bfea0a47958c72d0ea1305c68e629f..4801e5134d101cd394ccb201c90e7c983a131483 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -4,18 +4,15 @@ Model options The following inputs are defined using the prefix ``mfix``: -+--------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| | Description | Type | Default | -+==========================+============================================================================+==========+=====================+ -| gravity | Gravity vector. | Reals<3> | 0 0 0 | -+--------------------------+----------------------------------------------------------------------------+----------+---------------------+ ++--------------------------+----------------------------------------------------------------------------+----------+---------+ +| | Description | Type | Default | ++==========================+============================================================================+==========+=========+ +| gravity | Gravity vector. | Reals<3> | 0 0 0 | ++--------------------------+----------------------------------------------------------------------------+----------+---------+ Enabling solvers ---------------- - - - The following input is defined using the prefix ``mfix``: +--------------------------+----------------------------------------------------------------------------+----------+---------------------+ @@ -139,6 +136,8 @@ The following inputs are defined using the prefix ``solids``: +---------------------+---------------------------------------------------------------------------+-------------+-----------+ | energy.source | User defined enthalpy source for particles. | Real | 0. | +---------------------+---------------------------------------------------------------------------+-------------+-----------+ +| prevent_outflow | Prevent particles from exiting at pressure outlets. | Int | 0 | ++---------------------+---------------------------------------------------------------------------+-------------+-----------+ @@ -182,8 +181,8 @@ in each direction, then subtracted from each particle's velocity vector so that for the system is zero. -Fluid-particle couping ----------------------- +Fluid-particle coupling +----------------------- Drag coefficient ^^^^^^^^^^^^^^^^ diff --git a/docs/source_docs/user_guide/inputs/output/plotting.rst b/docs/source_docs/user_guide/inputs/output/plotting.rst index bdab75881c9ae9c939c1ba145dd71f24dda9216a..4770b834435edc6d31d25c41d193778d99b50850 100644 --- a/docs/source_docs/user_guide/inputs/output/plotting.rst +++ b/docs/source_docs/user_guide/inputs/output/plotting.rst @@ -71,6 +71,8 @@ The following inputs must be preceded by the prefix ``mfix`` and control which v +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | plt_vort | Plot fluid vorticity. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +| plt_X_g | Plot fluid species mass fractions. | Int | 0 | ++---------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by the prefix ``mfix.solids`` and allow to write additional plotfiles which contain only solids variables in specific regions at fixed timesteps or approximated simulation times. diff --git a/docs/source_docs/user_guide/inputs/species.rst b/docs/source_docs/user_guide/inputs/species.rst index f94ad72d422b417124f666fbfd26a527923fbdd0..0b40d444efb3e074eb8163c8ba699ab9370bfc9f 100644 --- a/docs/source_docs/user_guide/inputs/species.rst +++ b/docs/source_docs/user_guide/inputs/species.rst @@ -155,12 +155,11 @@ The following input is defined using the prefix ``species.viscosity.molecular`` +------------------------+-------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +========================+=========================================================================+==========+===========+ -| model | Molecular viscosity model of species. This setting only applies when | String | None | +| model | Molecular viscosity model of species. This setting only applies when | String | constant | | | ``[fluid_name].viscosity.molecular`` = ``mixture``. | | | | | | | | | | Options: | | | | | | | | -| | * ``None`` - no viscosity model | | | | | * ``constant`` - constant viscosity | | | | | * ``Sutherland`` :cite:p:`suth1893` | | | | | * ``Reid`` :cite:p:`reid87` | | | @@ -174,23 +173,23 @@ The following inputs are defined for each species using the prefix ``species.[sp +------------------------+-------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +========================+=========================================================================+==========+===========+ -| constant | Constant species fluid viscosity. | Real | 0 | +| constant | Constant species fluid viscosity. | Real | None | | | | | | | | A value is required for ``constant`` species viscosity model. | | | +------------------------+-------------------------------------------------------------------------+----------+-----------+ -| Sutherland.T_ref | Sutherland model reference temperature for species. | Real | 0 | +| Sutherland.T_ref | Sutherland model reference temperature for species. | Real | None | | | | | | | | A value is required for ``Sutherland`` species viscosity model. | | | +------------------------+-------------------------------------------------------------------------+----------+-----------+ -| Sutherland.mu_ref | Sutherland model reference viscosity at T_ref for species. | Real | 0 | +| Sutherland.mu_ref | Sutherland model reference viscosity at T_ref for species. | Real | None | | | | | | | | A value is required for ``Sutherland`` species viscosity model. | | | +------------------------+-------------------------------------------------------------------------+----------+-----------+ -| Sutherland.S | Sutherland model temperature for species. | Real | 0 | +| Sutherland.S | Sutherland model temperature for species. | Real | None | | | | | | | | A value is required for ``Sutherland`` species viscosity model. | | | +------------------------+-------------------------------------------------------------------------+----------+-----------+ -| Reid.A | Reid model constants for species. | Real | 0 | +| Reid.A | Reid model constants for species. | Real | None | | Reid.B | | | | | Reid.C | Values are required for ``Reid`` species viscosity model. | | | | Reid.D | | | |