Loading docs/source_docs/tutorials/fluid/steady-flow-around-cylinder.rst +2 −2 Viewed Changes for docs/source_docs/tutorials/fluid/steady-flow-around-cylinder.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -156,9 +156,9 @@ not redefine the cylinder geometry used by the flow solver. regions.eb_cyl.cylinder.start = 0.2 0.0 -0.205 regions.eb_cyl.cylinder.end = 0.2 0.0 0.205 mfix.reports.eb_drag.regions = eb_cyl output.reports.eb_drag.regions = eb_cyl mfix.reports.eb_drag.eb_cyl.int = 500 output.reports.eb_drag.eb_cyl.int = 500 This report calculates the total aerodynamic force by integrating the fluid's pressure and shear stress over the captured surface: Loading docs/source_docs/tutorials/fluid/steady-flow-around-sphere.rst +2 −2 Viewed Changes for docs/source_docs/tutorials/fluid/steady-flow-around-sphere.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -107,8 +107,8 @@ the sphere, is used only to define where the drag report integrates: regions.eb_sphere.sphere.radius = 0.75 regions.eb_sphere.sphere.center = 0.0 0.0 0.0 mfix.reports.eb_drag.regions = eb_sphere mfix.reports.eb_drag.eb_sphere.int = 500 output.reports.eb_drag.regions = eb_sphere output.reports.eb_drag.eb_sphere.int = 500 The fluid viscosity sets the Reynolds number: Loading docs/source_docs/tutorials/fluid/unsteady-flow-around-sphere.rst +2 −2 Viewed Changes for docs/source_docs/tutorials/fluid/unsteady-flow-around-sphere.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -107,8 +107,8 @@ tutorial, to adequately resolve the shedding frequency: .. code-block:: text mfix.reports.eb_drag.regions = eb_sphere mfix.reports.eb_drag.eb_sphere.int = 3 output.reports.eb_drag.regions = eb_sphere output.reports.eb_drag.eb_sphere.int = 3 .. note:: Loading docs/source_docs/user_guide/inputs/output/ascent.rst +21 −15 Viewed Changes for docs/source_docs/user_guide/inputs/output/ascent.rst: 21 added lines, 15 removed lines. Original line number Diff line number Diff line Loading @@ -7,30 +7,36 @@ Ascent `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. The following inputs must be preceded by the prefix ``output.ascent`` and control frequency of the Ascent pipeline. +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | ascent_int | Frequency of ascent pipeline in timesteps; -1 to disable ascent | Int | -1 | | actions | Name of yaml file of the ascent actions (ex. ascent_actions.yaml). If | String | | | | no file name is provided, then calls to Ascent are skipped. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | int | Frequency of ascent pipeline in timesteps; -1 to disable ascent | Int | -1 | | | pipeline based on timesteps. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | ascent_per_approx | Time period of the ascent pipeline in simulation time (approximate); | Real | -1 | | per_approx | Time period of the ascent pipeline in simulation time (approximate); | Real | -1 | | | -1 to disable ascent pipeline based on simulation time. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | on_restart | Run the Ascent pipeline when restarting a run. | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.variables | Fluid variables to publish, from the fluid variable names in | Strings | see below | | | :ref:`Plotfiles<Chap:InputsPlotfiles>`. Defaults to the historical | | | | | Ascent field set when unset: ``eb_volume_fraction``, ``velocity``, | | | | | ``volume_fraction``, ``temperature``, ``species`` | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ .. note:: 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``. Ascent actions must reference the variable name listed in :ref:`Plotfiles<Chap:InputsPlotfiles>`. For example, velocity components are identified as `u_g``, ``v_g``, ``w_g``, phasic fluid volume fraction as ``ep_g`` and the geometric volume fraction as ``volfrac``. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | actions | Name of yaml file of the ascent actions (ex. ascent_actions.yaml). If | String | | | | no file name is provided, then calls to Ascent are skipped. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ .. warning:: If an Ascent pipeline is being included in a GPU build/run, then you must enable managed memory by setting ``amrex.the_arena_is_managed = true``. docs/source_docs/user_guide/inputs/output/catalyst.rst 0 → 100644 +37 −0 Viewed Changes for docs/source_docs/user_guide/inputs/output/catalyst.rst: 37 added lines, 0 removed lines. Original line number Diff line number Diff line .. _Chap:InputsCatalyst: Catalyst ======== `Catalyst <https://catalyst-in-situ.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization. MFIX-Exa must be built with Catalyst support to use this feature. The following inputs must be preceded by the prefix ``output.catalyst``. +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | enabled | Run the Catalyst pipeline. | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | int | Frequency of the Catalyst pipeline in timesteps; -1 to disable the | Int | 1 | | | pipeline based on timesteps. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | per_approx | Time period of the Catalyst pipeline in simulation time | Real | -1 | | | (approximate); -1 to disable the pipeline based on simulation time. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | on_restart | Run the Catalyst pipeline when restarting a run. | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | script | Catalyst pipeline script to execute. | String | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | implementation | Name of the Catalyst implementation to load. | String | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | library_path | Directory to search for the Catalyst implementation. | String | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.variables | Fluid variables to publish, from the fluid variable names in | Strings | see below | | | :ref:`Plotfiles<Chap:InputsPlotfiles>`. Defaults to the historical | | | | | Catalyst field set when unset. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The variable names are the same ones the plotfile uses; see :ref:`Plotfiles<Chap:InputsPlotfiles>` for the available options. Loading
docs/source_docs/tutorials/fluid/steady-flow-around-cylinder.rst +2 −2 Viewed Changes for docs/source_docs/tutorials/fluid/steady-flow-around-cylinder.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -156,9 +156,9 @@ not redefine the cylinder geometry used by the flow solver. regions.eb_cyl.cylinder.start = 0.2 0.0 -0.205 regions.eb_cyl.cylinder.end = 0.2 0.0 0.205 mfix.reports.eb_drag.regions = eb_cyl output.reports.eb_drag.regions = eb_cyl mfix.reports.eb_drag.eb_cyl.int = 500 output.reports.eb_drag.eb_cyl.int = 500 This report calculates the total aerodynamic force by integrating the fluid's pressure and shear stress over the captured surface: Loading
docs/source_docs/tutorials/fluid/steady-flow-around-sphere.rst +2 −2 Viewed Changes for docs/source_docs/tutorials/fluid/steady-flow-around-sphere.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -107,8 +107,8 @@ the sphere, is used only to define where the drag report integrates: regions.eb_sphere.sphere.radius = 0.75 regions.eb_sphere.sphere.center = 0.0 0.0 0.0 mfix.reports.eb_drag.regions = eb_sphere mfix.reports.eb_drag.eb_sphere.int = 500 output.reports.eb_drag.regions = eb_sphere output.reports.eb_drag.eb_sphere.int = 500 The fluid viscosity sets the Reynolds number: Loading
docs/source_docs/tutorials/fluid/unsteady-flow-around-sphere.rst +2 −2 Viewed Changes for docs/source_docs/tutorials/fluid/unsteady-flow-around-sphere.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -107,8 +107,8 @@ tutorial, to adequately resolve the shedding frequency: .. code-block:: text mfix.reports.eb_drag.regions = eb_sphere mfix.reports.eb_drag.eb_sphere.int = 3 output.reports.eb_drag.regions = eb_sphere output.reports.eb_drag.eb_sphere.int = 3 .. note:: Loading
docs/source_docs/user_guide/inputs/output/ascent.rst +21 −15 Viewed Changes for docs/source_docs/user_guide/inputs/output/ascent.rst: 21 added lines, 15 removed lines. Original line number Diff line number Diff line Loading @@ -7,30 +7,36 @@ Ascent `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. The following inputs must be preceded by the prefix ``output.ascent`` and control frequency of the Ascent pipeline. +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | ascent_int | Frequency of ascent pipeline in timesteps; -1 to disable ascent | Int | -1 | | actions | Name of yaml file of the ascent actions (ex. ascent_actions.yaml). If | String | | | | no file name is provided, then calls to Ascent are skipped. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | int | Frequency of ascent pipeline in timesteps; -1 to disable ascent | Int | -1 | | | pipeline based on timesteps. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | ascent_per_approx | Time period of the ascent pipeline in simulation time (approximate); | Real | -1 | | per_approx | Time period of the ascent pipeline in simulation time (approximate); | Real | -1 | | | -1 to disable ascent pipeline based on simulation time. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | on_restart | Run the Ascent pipeline when restarting a run. | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.variables | Fluid variables to publish, from the fluid variable names in | Strings | see below | | | :ref:`Plotfiles<Chap:InputsPlotfiles>`. Defaults to the historical | | | | | Ascent field set when unset: ``eb_volume_fraction``, ``velocity``, | | | | | ``volume_fraction``, ``temperature``, ``species`` | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ .. note:: 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``. Ascent actions must reference the variable name listed in :ref:`Plotfiles<Chap:InputsPlotfiles>`. For example, velocity components are identified as `u_g``, ``v_g``, ``w_g``, phasic fluid volume fraction as ``ep_g`` and the geometric volume fraction as ``volfrac``. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | actions | Name of yaml file of the ascent actions (ex. ascent_actions.yaml). If | String | | | | no file name is provided, then calls to Ascent are skipped. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ .. warning:: If an Ascent pipeline is being included in a GPU build/run, then you must enable managed memory by setting ``amrex.the_arena_is_managed = true``.
docs/source_docs/user_guide/inputs/output/catalyst.rst 0 → 100644 +37 −0 Viewed Changes for docs/source_docs/user_guide/inputs/output/catalyst.rst: 37 added lines, 0 removed lines. Original line number Diff line number Diff line .. _Chap:InputsCatalyst: Catalyst ======== `Catalyst <https://catalyst-in-situ.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization. MFIX-Exa must be built with Catalyst support to use this feature. The following inputs must be preceded by the prefix ``output.catalyst``. +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | enabled | Run the Catalyst pipeline. | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | int | Frequency of the Catalyst pipeline in timesteps; -1 to disable the | Int | 1 | | | pipeline based on timesteps. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | per_approx | Time period of the Catalyst pipeline in simulation time | Real | -1 | | | (approximate); -1 to disable the pipeline based on simulation time. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | on_restart | Run the Catalyst pipeline when restarting a run. | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | script | Catalyst pipeline script to execute. | String | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | implementation | Name of the Catalyst implementation to load. | String | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | library_path | Directory to search for the Catalyst implementation. | String | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.variables | Fluid variables to publish, from the fluid variable names in | Strings | see below | | | :ref:`Plotfiles<Chap:InputsPlotfiles>`. Defaults to the historical | | | | | Catalyst field set when unset. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The variable names are the same ones the plotfile uses; see :ref:`Plotfiles<Chap:InputsPlotfiles>` for the available options.