Loading docs/source_docs/user_guide/inputs/output/ascent.rst +14 −10 Viewed Changes for docs/source_docs/user_guide/inputs/output/ascent.rst: 14 added lines, 10 removed lines. 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 docs/source_docs/user_guide/inputs/output/plotting.rst +10 −28 Viewed Changes for docs/source_docs/user_guide/inputs/output/plotting.rst: 10 added lines, 28 removed lines. Original line number Diff line number Diff line Loading @@ -4,7 +4,7 @@ Plotfiles and other output ========================== 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, and if the particles should be written out in Ascii as whether the EB geometry or level set should be written, and if the particles should be written out in ASCII format (for debugging). +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -20,23 +20,17 @@ format (for debugging). +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | plot_file | Prefix to use for plotfile output | String | plt | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_file | Prefix to use for ascii particle output | String | par | | par_ascii_file | Prefix to use for ASCII particle output | String | par | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_int | Frequency of ascii particle output; | Int | -1 | | | if -1 then no particle ascii files will be written | | | | par_ascii_int | Frequency of ASCII particle output; | Int | -1 | | | if -1 then no particle ASCII files will be written | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_per_approx | Time period of the ascii particle output (approximate); | Real | -1 | | | if -1 then particle ascii files will not be written at this frequency | | | | par_ascii_per_approx | Time period of the ASCII particle output (approximate); | Real | -1 | | | if -1 then particle ASCII files will not be written at this frequency | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | file_digits | Number of digits to use in plotfile (plt[0-9]+) and checkpoint | Int | 5 | | | (chk[0-9]+) filenames. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | ascent_int | Frequency of ascent pipeline; | Int | -1 | | | if -1 then ascent will not be called. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | ascent_per_approx | Time period of the ascent pipeline (approximate); | Real | -1 | | | if -1 then ascent will not be called. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by the prefix ``mfix`` and control which variables will be written in plotfiles. Loading Loading @@ -98,22 +92,6 @@ The following inputs must be preceded by the prefix ``mfix`` and control whether +----------------------+--------------------------------------------------------------------------+-------------+-----------+ `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`. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | actions | yaml file of the ascent actions (ex. ascent_actions.yaml). If no file | String | | | | name is provided, then calls to Ascent are skipped. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ 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. All these parameters are user-defined. Loading Loading @@ -178,3 +156,7 @@ region. mfix.solids.my_region.plot_int = 10 mfix.solids.my_region.plt_vel_p = 1 `Ascent` has been integrated into MFIX-Exa for *in situ* visualization. See :ref:`Ascent<Chap:InputsAscent>` for details. docs/source_docs/user_guide/inputs/chemical_reactions.rst +1 −1 Viewed Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 1 added line, 1 removed line. 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 Viewed Changes for docs/source_docs/user_guide/inputs/fluid_model.rst: 5 added lines, 4 removed lines. 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 Viewed Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 4 added lines, 4 removed lines. 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 Loading
docs/source_docs/user_guide/inputs/output/ascent.rst +14 −10 Viewed Changes for docs/source_docs/user_guide/inputs/output/ascent.rst: 14 added lines, 10 removed lines. 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
docs/source_docs/user_guide/inputs/output/plotting.rst +10 −28 Viewed Changes for docs/source_docs/user_guide/inputs/output/plotting.rst: 10 added lines, 28 removed lines. Original line number Diff line number Diff line Loading @@ -4,7 +4,7 @@ Plotfiles and other output ========================== 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, and if the particles should be written out in Ascii as whether the EB geometry or level set should be written, and if the particles should be written out in ASCII format (for debugging). +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -20,23 +20,17 @@ format (for debugging). +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | plot_file | Prefix to use for plotfile output | String | plt | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_file | Prefix to use for ascii particle output | String | par | | par_ascii_file | Prefix to use for ASCII particle output | String | par | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_int | Frequency of ascii particle output; | Int | -1 | | | if -1 then no particle ascii files will be written | | | | par_ascii_int | Frequency of ASCII particle output; | Int | -1 | | | if -1 then no particle ASCII files will be written | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_per_approx | Time period of the ascii particle output (approximate); | Real | -1 | | | if -1 then particle ascii files will not be written at this frequency | | | | par_ascii_per_approx | Time period of the ASCII particle output (approximate); | Real | -1 | | | if -1 then particle ASCII files will not be written at this frequency | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | file_digits | Number of digits to use in plotfile (plt[0-9]+) and checkpoint | Int | 5 | | | (chk[0-9]+) filenames. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | ascent_int | Frequency of ascent pipeline; | Int | -1 | | | if -1 then ascent will not be called. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | ascent_per_approx | Time period of the ascent pipeline (approximate); | Real | -1 | | | if -1 then ascent will not be called. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by the prefix ``mfix`` and control which variables will be written in plotfiles. Loading Loading @@ -98,22 +92,6 @@ The following inputs must be preceded by the prefix ``mfix`` and control whether +----------------------+--------------------------------------------------------------------------+-------------+-----------+ `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`. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | actions | yaml file of the ascent actions (ex. ascent_actions.yaml). If no file | String | | | | name is provided, then calls to Ascent are skipped. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ 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. All these parameters are user-defined. Loading Loading @@ -178,3 +156,7 @@ region. mfix.solids.my_region.plot_int = 10 mfix.solids.my_region.plt_vel_p = 1 `Ascent` has been integrated into MFIX-Exa for *in situ* visualization. See :ref:`Ascent<Chap:InputsAscent>` for details.
docs/source_docs/user_guide/inputs/chemical_reactions.rst +1 −1 Viewed Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 1 added line, 1 removed line. 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 Viewed Changes for docs/source_docs/user_guide/inputs/fluid_model.rst: 5 added lines, 4 removed lines. 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 Viewed Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 4 added lines, 4 removed lines. 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