Loading docs/source_docs/user_guide/inputs/chemical_reactions.rst +1 −1 Original line number Diff line number Diff line Loading @@ -27,7 +27,7 @@ The following inputs are defined using the prefix ``chemistry``: | | |tol_eq| | | | | | | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.update_type | How to update solids quantities due to chemical | | ConstantVolume | | solids.update_type | How to update solids quantities due to chemical | String | ConstantVolume | | | reactions. | | | | | | | | | | Options: | | | Loading docs/source_docs/user_guide/inputs/fluid_model.rst +5 −4 Original line number Diff line number Diff line Loading @@ -8,10 +8,11 @@ The following inputs are defined using the prefix ``fluid``: +--------------------------------------------+-------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +============================================+=============================================================+========+==========+ | solve | Specify the name of the fluid or set to ``None`` to disable | String | "None" | | | the fluid solver. The name assigned to the fluid solver is | | | | | used to specify fluid properties and initial and boundary | | | | | conditions. It is common to use the name ``fluid``. | | | | solve | Specify the name of the fluid or set to empty string or | String | None | | | ``None`` to disable the fluid solver. The name assigned to | | | | | the fluid solver is used to specify fluid properties and | | | | | initial and boundary conditions. It is common to use the | | | | | name ``fluid``. | | | +--------------------------------------------+-------------------------------------------------------------+--------+----------+ Loading docs/source_docs/user_guide/inputs/initial_conditions.rst +4 −4 Original line number Diff line number Diff line Loading @@ -44,7 +44,7 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of ``species_name`` | Real | 0 | | species.[species_name] | Mass fraction of ``species_name``. Species must be a fluid species. | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -90,7 +90,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | temperature | temperature | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of `species_name` | Real | 0 | | species.[species_name] | Mass fraction of `species_name`. Must be a solid species. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -166,12 +166,12 @@ The following inputs must be preceded by the prefix ``mfix``: +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | particle_init_type | Particle initialization method. | String | AsciiFile | | particle_init_type | Particle initialization method. | String | ASCIIFile | | | | | | | | Options: | | | | | | | | | | * ``Auto`` - automatic particle generation | | | | | * ``AsciiFile`` - read particle data from file ``particle_input.dat`` | | | | | * ``ASCIIFile`` - read particle data from file ``particle_input.dat`` | | | | | | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading docs/source_docs/user_guide/inputs/model_options.rst +8 −7 Original line number Diff line number Diff line Loading @@ -74,21 +74,22 @@ The following inputs are defined using the prefix ``mfix``: +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_coeff_in_proj_gp | Algebraically consistent p coeff in proj or (default) simplified form.| Bool | false | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | godunov_ppm | When using Godunov, use piecewise parabolic (PPM) instead of | Bool | false | | | piecewise linear (PLM) reconstruction. | | | | 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. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_mac_phi_in_godunov | When using Godunov, don't include the pressure gradient in the | Bool | false | | 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. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | correction_small_volfrac | Threshold volume fraction for correcting small cell velocity | | | | | at the end of the predictor and corrector. | Real | 1.e-4 | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading @@ -371,6 +372,6 @@ The following input is defined using the prefix ``mfix.convection``: | | | | | | | * ``RanzMarshall`` :cite:p:`ranz52` | | | | | * ``Gunn`` :cite:p:`gunn78` | | | | | * ``NullConvection`` - disable fluid-particle heat transfer | | | | | * ``None`` - disable fluid-particle heat transfer | | | | | | | | +-------------------+-----------------------------------------------------------------------+-------------+--------------+ docs/source_docs/user_guide/inputs/output/ascent.rst +14 −10 Original line number Diff line number Diff line .. _Chap:InputsAscent: Ascent ====== The following inputs must be preceded by the prefix ``mfix`` and control frequency and naming of plotfile generation as well as whether the EB geometry or level set should be written out, and if the particles should be written out in Ascii format (for debugging). `Ascent <https://ascent.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization. MFIX-Exa must be built with Ascent support to use this feature. The following inputs must be preceded by the prefix ``mfix`` and control frequency of the Ascent pipeline. +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -16,13 +21,12 @@ format (for debugging). +----------------------+-----------------------------------------------------------------------+-------------+-----------+ `Ascent <ascent.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization. For codes that have been built with Ascent support, the following input must be preceded by the prefix ``ascent``, and specifies the ascent actions for fluid and/or particles. The frequency which these are called is controlled by `ascent_int` or `ascent_per_approx`, see above. Note that if an ascent pipeline is being included in a GPU build/run, then you must enable managed memory, i.e., set `amrex.the_arena_is_managed = true`. The following input must be preceded by the prefix ``ascent``, and specifies the Ascent actions for fluid and/or particles. The frequency which these are called is controlled by ``ascent_int`` or ``ascent_per_approx``, see above. Note that if an Ascent pipeline is being included in a GPU build/run, then you must enable managed memory,i.e., set ``amrex.the_arena_is_managed = true``. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading Loading
docs/source_docs/user_guide/inputs/chemical_reactions.rst +1 −1 Original line number Diff line number Diff line Loading @@ -27,7 +27,7 @@ The following inputs are defined using the prefix ``chemistry``: | | |tol_eq| | | | | | | | | +--------------------------+---------------------------------------------------------+----------+----------------+ | solids.update_type | How to update solids quantities due to chemical | | ConstantVolume | | solids.update_type | How to update solids quantities due to chemical | String | ConstantVolume | | | reactions. | | | | | | | | | | Options: | | | Loading
docs/source_docs/user_guide/inputs/fluid_model.rst +5 −4 Original line number Diff line number Diff line Loading @@ -8,10 +8,11 @@ The following inputs are defined using the prefix ``fluid``: +--------------------------------------------+-------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +============================================+=============================================================+========+==========+ | solve | Specify the name of the fluid or set to ``None`` to disable | String | "None" | | | the fluid solver. The name assigned to the fluid solver is | | | | | used to specify fluid properties and initial and boundary | | | | | conditions. It is common to use the name ``fluid``. | | | | solve | Specify the name of the fluid or set to empty string or | String | None | | | ``None`` to disable the fluid solver. The name assigned to | | | | | the fluid solver is used to specify fluid properties and | | | | | initial and boundary conditions. It is common to use the | | | | | name ``fluid``. | | | +--------------------------------------------+-------------------------------------------------------------+--------+----------+ Loading
docs/source_docs/user_guide/inputs/initial_conditions.rst +4 −4 Original line number Diff line number Diff line Loading @@ -44,7 +44,7 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of ``species_name`` | Real | 0 | | species.[species_name] | Mass fraction of ``species_name``. Species must be a fluid species. | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -90,7 +90,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | temperature | temperature | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of `species_name` | Real | 0 | | species.[species_name] | Mass fraction of `species_name`. Must be a solid species. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -166,12 +166,12 @@ The following inputs must be preceded by the prefix ``mfix``: +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | particle_init_type | Particle initialization method. | String | AsciiFile | | particle_init_type | Particle initialization method. | String | ASCIIFile | | | | | | | | Options: | | | | | | | | | | * ``Auto`` - automatic particle generation | | | | | * ``AsciiFile`` - read particle data from file ``particle_input.dat`` | | | | | * ``ASCIIFile`` - read particle data from file ``particle_input.dat`` | | | | | | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading
docs/source_docs/user_guide/inputs/model_options.rst +8 −7 Original line number Diff line number Diff line Loading @@ -74,21 +74,22 @@ The following inputs are defined using the prefix ``mfix``: +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_coeff_in_proj_gp | Algebraically consistent p coeff in proj or (default) simplified form.| Bool | false | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | godunov_ppm | When using Godunov, use piecewise parabolic (PPM) instead of | Bool | false | | | piecewise linear (PLM) reconstruction. | | | | 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. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_mac_phi_in_godunov | When using Godunov, don't include the pressure gradient in the | Bool | false | | 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. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | correction_small_volfrac | Threshold volume fraction for correcting small cell velocity | | | | | at the end of the predictor and corrector. | Real | 1.e-4 | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading @@ -371,6 +372,6 @@ The following input is defined using the prefix ``mfix.convection``: | | | | | | | * ``RanzMarshall`` :cite:p:`ranz52` | | | | | * ``Gunn`` :cite:p:`gunn78` | | | | | * ``NullConvection`` - disable fluid-particle heat transfer | | | | | * ``None`` - disable fluid-particle heat transfer | | | | | | | | +-------------------+-----------------------------------------------------------------------+-------------+--------------+
docs/source_docs/user_guide/inputs/output/ascent.rst +14 −10 Original line number Diff line number Diff line .. _Chap:InputsAscent: Ascent ====== The following inputs must be preceded by the prefix ``mfix`` and control frequency and naming of plotfile generation as well as whether the EB geometry or level set should be written out, and if the particles should be written out in Ascii format (for debugging). `Ascent <https://ascent.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization. MFIX-Exa must be built with Ascent support to use this feature. The following inputs must be preceded by the prefix ``mfix`` and control frequency of the Ascent pipeline. +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -16,13 +21,12 @@ format (for debugging). +----------------------+-----------------------------------------------------------------------+-------------+-----------+ `Ascent <ascent.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization. For codes that have been built with Ascent support, the following input must be preceded by the prefix ``ascent``, and specifies the ascent actions for fluid and/or particles. The frequency which these are called is controlled by `ascent_int` or `ascent_per_approx`, see above. Note that if an ascent pipeline is being included in a GPU build/run, then you must enable managed memory, i.e., set `amrex.the_arena_is_managed = true`. The following input must be preceded by the prefix ``ascent``, and specifies the Ascent actions for fluid and/or particles. The frequency which these are called is controlled by ``ascent_int`` or ``ascent_per_approx``, see above. Note that if an Ascent pipeline is being included in a GPU build/run, then you must enable managed memory,i.e., set ``amrex.the_arena_is_managed = true``. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading
