diff --git a/docs/source_docs/user_guide/inputs/geometry.rst b/docs/source_docs/user_guide/inputs/geometry.rst index bc4f7ccb557843f65e110447e50e446476036cd7..63582d8bf0fd2ac8f43be27fbbdf461a29c1766f 100644 --- a/docs/source_docs/user_guide/inputs/geometry.rst +++ b/docs/source_docs/user_guide/inputs/geometry.rst @@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===============================================================================+==========+=====================+ -| geometry | Simulation geometry type. | String | 'box' | +| geometry | Simulation geometry type. | String | | | | Options (case-insensitive): | | | | | | | | | | * ``box`` - predefined :ref:`box geometry` | | | @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix``: | | * ``None`` - no embedded boundary -- all domain faces must be specified | | | | | | | | +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ -| levelset__refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | +| levelset_refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | | | resolution | | | +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 5c1397c4fb070152884e813222231f1fd283a216..f11846206603e0b6da23af1d2a8bd197d20000c5 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -88,7 +88,7 @@ please refer to :ref:`ReferenceParticleDistributions 0 - -and - - .. math:: \left|v_p\right| \geq \left| \frac{x_p - h}{\Delta t} \right| - - Flow rate +--------------------------------+ | Lagrangian::FlowRate::FlowRate | +--------------------------------+ - The net flow rate of a general particle property :math:`\phi_p` is computed + Net flow rate of a general particle property :math:`\phi_p` is computed by summing the properties of the set of particles projected to have crossed - the flow plane, :math:`\Gamma`. + the flow plane., :math:`\Gamma`. - .. math:: \sum_{p \in \Gamma} w_p \phi_p \frac{v_p}{\left| v_p \right|} + .. math:: \sum_{p \in \Gamma} w_p \phi_p \frac{v_p}{\left|v_p\right|} Mass-weighted flow rate +--------------------------------------------+ | Lagrangian::FlowRate::MassWeightedFlowRate | +--------------------------------------------+ - The net mass-weighted flow rate is the sum of the general particle property + Net mass-weighted flow rate is the sum of the general particle property :math:`\phi_p` multiplied by the particle mass, :math:`m_p` of the set of particles projected to have crossed the flow plane, :math:`\Gamma`. - .. math:: \sum_{p \in \Gamma} w_p m_p \phi_p \frac{v_p}{\left| v_p \right|} + .. math:: \sum_{p \in \Gamma} w_p m_p \phi_p \frac{v_p}{\left|v_p\right|} Volume-weighted flow rate +----------------------------------------------+ | Lagrangian::FlowRate::VolumeWeightedFlowRate | +----------------------------------------------+ - The net volume-weighted flow rate is the sum of the general particle property + Net volume-weighted flow rate is the sum of the general particle property :math:`\phi_p` multiplied by the particle volume, :math:`V_p` of the set of particles projected to have crossed the flow plane, :math:`\Gamma`. - .. math:: \sum_{p \in \Gamma}\phi_p w_p V_p \frac{v_p}{\left| v_p \right|} + .. math:: \sum_{p \in \Gamma}\phi_p w_p V_p \frac{v_p}{\left|v_p\right|} + + +.. code-block:: none + + mfix.monitors = my_monitor0 my_monitor1 + + mfix.monitors.my_monitor0 = Eulerian::VolumeIntegral::MassWeightedIntegral + mfix.monitors.my_monitor1 = Lagrangian::Average::VolumeWeightedAverage diff --git a/docs/source_docs/user_guide/inputs/output/plotting.rst b/docs/source_docs/user_guide/inputs/output/plotting.rst index 7ec117b1a41c5a82bda463283af1c6c04736b083..60216b94a6a691f004f98442caa6bfdfb1e33016 100644 --- a/docs/source_docs/user_guide/inputs/output/plotting.rst +++ b/docs/source_docs/user_guide/inputs/output/plotting.rst @@ -3,33 +3,24 @@ 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 -format (for debugging). +The following inputs must be preceded by the prefix ``mfix`` and control frequency and naming of plotfile generation. + +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ -| plot_int | Frequency of plotfile output; | Int | -1 | -| | if -1 then no plotfiles will be written at this frequency | | | -+----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plot_per_approx | Time period of plotfile output (approximate); does not modify dt | Real | -1 | -| | if -1 then no plotfiles will be written at this frequency | | | -+----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plotfile_on_restart | Write a plotfile when we restart (only used if plot_int>0) | Bool | false | +| plot_file | Prefix to use for plotfile output. | String | plt | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plot_file | Prefix to use for plotfile output | String | plt | +| file_digits | Number of digits to use in plotfile (plt[0-9]+) and checkpoint | Int | 5 | +| | (chk[0-9]+) filenames. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| par_ascii_file | Prefix to use for ASCII particle output | String | par | +| plot_int | Plotting interval in timesteps (0 to disable). | Int | 0 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| par_ascii_int | Frequency of ASCII particle output; | Int | -1 | -| | if -1 then no particle ASCII files will be written | | | +| plot_per_approx | Approximate plotting interval in simulation time (does not modify dt).| Real | 0 | +| | 0 to disable. Only one of ``plot_int`` or ``plot_per_approx`` may be | | | +| | specified. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| 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. | | | +| plot_on_restart | Write a plotfile when restarting (only used if ``plot_int``>0). | Bool | false | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -38,116 +29,97 @@ The following inputs must be preceded by the prefix ``mfix`` and control which v +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ -| plt_regtest | Plot all variables (overrides all other plot flags) | Int | 0 | +| plt_regtest | Plot all variables (overrides all other plot flags). | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_drag_p | Plot particle drag force | Int | 0 | +| plt_drag_p | Plot particle drag force. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_ep_g | Plot fluid volume fraction | Int | 1 | +| plt_ep_g | Plot fluid volume fraction. | Int | 1 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_gradp_g | Plot gradient of fluid pressure | Int | 0 | +| plt_gradp_g | Plot fluid pressure gradient. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_mu_g | Plot fluid molecular viscosity | Int | 0 | +| plt_mu_g | Plot fluid molecular viscosity. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_omega_p | Plot particle angular velocity | Int | 0 | +| plt_omega_p | Plot particle angular velocity. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_p_g | Plot fluid pressure | Int | 0 | +| plt_p_g | Plot fluid pressure. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_phase | Plot particle type | Int | 0 | +| plt_phase | Plot particle type. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_radius | Plot particle radius | Int | 0 | +| plt_radius | Plot particle radius. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_ro_g | Plot fluid density | Int | 0 | +| plt_ro_g | Plot fluid density. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_ro_p | Plot particle density | Int | 0 | +| plt_ro_p | Plot particle density. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_statwt | Plot particle (parcel) statistical weight | Int | 0 | +| plt_statwt | Plot particle (parcel) statistical weight. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_T_g | Plot fluid temperature | Int | 0 | +| plt_T_g | Plot fluid temperature. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_T_p | Plot particle temperature | Int | 0 | +| plt_T_p | Plot particle temperature. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_vel_g | Plot fluid velocity data | Int | 1 | +| plt_vel_g | Plot fluid velocity data. | Int | 1 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_vel_p | Plot particle velocity | Int | 1 | +| plt_vel_p | Plot particle velocity. | Int | 1 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_volfrac | Plot Eulerian grid volume fraction (from cut cells) | Int | 0 | +| plt_volfrac | Plot Eulerian grid volume fraction (from cut cells). | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| plt_vort | Plot vorticity | Int | 0 | +| plt_vort | Plot fluid vorticity. | Int | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ - -The following inputs must be preceded by the prefix ``mfix`` and control whether the EB geometry or level set should be written: - -+----------------------+--------------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+======================+==========================================================================+=============+===========+ -| write_ls | Write a plotfile holding the level set and volume fraction. | Bool | false | -| | If enabled, it will only be written once, after initialization or restart| | | -+----------------------+--------------------------------------------------------------------------+-------------+-----------+ -| write_eb_surface | Write out the EB geometry in vtp format. | Bool | false | -| | If enabled, it will only be written once, after initialization or restart| | | -+----------------------+--------------------------------------------------------------------------+-------------+-----------+ -| plt_geom | Write a plotfile holding the EB geometry data. | Bool | false | -| | If true, it will only be written once,after initialization or restart | | | -+----------------------+--------------------------------------------------------------------------+-------------+-----------+ - - 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. +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +================================+=================================================================+=============+===========+ -| regions | Specify regions that will be used for plotfiles | Strings | | -+--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name] | Specify which solids phases will be plotted | String | | +| regions | Specify regions that will be used for plotfiles. | Strings | | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plot_int | Specify timestep frequency for plotting the file | Int | 0 | +| [region_name] | Specify which solids phases will be plotted. | Strings | | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plot_per_approx | Specify time interval frequency for plotting the file | Real | 0 | +| [region_name].plot_int | Plotting interval in timesteps (0 to disable). | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_regtest | Plot all variables (overrides all other plot flags) | Int | 0 | +| [region_name].plot_per_approx | Approximate plotting interval in simulation time (does not | Real | 0 | +| | modify dt). 0 to disable. Only one of ``plot_int`` or | | | +| | ``plot_per_approx`` may be specified. | | | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_cp_s | Plot particle specific heat coefficient | Int | 0 | +| [region_name].plt_regtest | Plot all variables (overrides all other plot flags). | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_drag_p | Plot particle drag force | Int | 0 | +| [region_name].plt_cp_s | Plot particle specific heat coefficient. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_h_s_txfr | Plot particle interphase enthalpy transfer | Int | 0 | +| [region_name].plt_drag_p | Plot particle drag force. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_mass | Plot particle mass | Int | 0 | +| [region_name].plt_h_s_txfr | Plot particle interphase enthalpy transfer. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_mass_sn_txfr | Plot particle interphase mass transfer | Int | 0 | +| [region_name].plt_mass | Plot particle mass. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_omega_p | Plot particle angular velocity | Int | 0 | +| [region_name].plt_mass_sn_txfr | Plot particle interphase mass transfer. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_omoi | Plot inverse of particle momentum of inertia | Int | 0 | +| [region_name].plt_omega_p | Plot particle angular velocity. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_phase | Plot particle phase | Int | 0 | +| [region_name].plt_omoi | Plot particle inverse momentum of inertia. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_radius | Plot particle radius | Int | 0 | +| [region_name].plt_phase | Plot particle phase. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_ro_p | Plot particle density | Int | 0 | +| [region_name].plt_radius | Plot particle radius. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_state | Plot particle state | Int | 0 | +| [region_name].plt_ro_p | Plot particle density. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_statwt | Plot particle statistical weight | Int | 0 | +| [region_name].plt_statwt | Plot particle statistical weight. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_T_p | Plot particle temperature | Int | 0 | +| [region_name].plt_T_p | Plot particle temperature. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_vel_p | Plot particle velocity | Int | 0 | +| [region_name].plt_vel_p | Plot particle velocity. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_vel_s_txfr | Plot particle interphase velocity transfer | Int | 0 | +| [region_name].plt_vel_s_txfr | Plot particle interphase velocity transfer. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_volume | Plot particle volume | Int | 0 | +| [region_name].plt_volume | Plot particle volume. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region_name].plt_X_s | Plot particle species mass fractions | Int | 0 | +| [region_name].plt_X_s | Plot particle species mass fractions. | Int | 0 | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ -For each region with name [region_name] specified in the inputs, it will be saved a plotfile with name "partsXXXXX_[region_name]", where XXXXX stands for the timestep number. +Files will be saved to a directory ``[region_name]`` using the ``plot_file`` prefix, e.g. ``region1/plt00000`` - -Below is an example for specifying the inputs to plot solids data in a given +Below is an example for specifying the inputs to plot solids data in a given region. .. code-block:: none @@ -158,5 +130,46 @@ region. mfix.solids.my_region.plt_vel_p = 1 +Debugging +========= + +The following inputs control whether particle data should be written out in ASCII format. +They must be preceded by the prefix ``mfix``. + ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++======================+=======================================================================+=============+===========+ +| par_ascii_file | Prefix to use for ASCII particle output file name. | String | par | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| par_ascii_int | ASCII particle output interval in timesteps. 0 to disable. | Int | 0 | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| par_ascii_per_approx | Approximate simulation time period for ASCII particle output. 0 to | Real | 0 | +| | disable. Only one of ``par_ascii_int`` or ``par_ascii_per_approx`` | | | +| | may be specified. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ + + +The following inputs control whether the EB geometry or level set should be written. +They must be preceded by the prefix ``mfix``. + ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++======================+=======================================================================+=============+===========+ +| write_ls | Write a plotfile containing the level set and volume fraction. | Bool | false | +| | If enabled, it will only be written once, after initialization or | | | +| | restart. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| write_eb_surface | Write the EB geometry in VTP format. | Bool | false | +| | If enabled, it will only be written once, after initialization or | | | +| | restart. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| write_geom | Write a plotfile containing the EB geometry data. | Bool | false | +| | If true, it will only be written once, after initialization or | | | +| | restart. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ + + + + `Ascent` has been integrated into MFIX-Exa for *in situ* visualization. See :ref:`Ascent` for details. diff --git a/docs/source_docs/user_guide/inputs/solids_model.rst b/docs/source_docs/user_guide/inputs/solids_model.rst index adfeaa0dd91e201e0967169b33f8df41f4a9eb91..68cf8d42e6b4b1c6242aca45a092a990857e261f 100644 --- a/docs/source_docs/user_guide/inputs/solids_model.rst +++ b/docs/source_docs/user_guide/inputs/solids_model.rst @@ -332,7 +332,7 @@ The following keywords control the iterative PIC algorithm and are defined with +====================================+=========================================================================+==========+===========+ | initial_step_type | Specifies the initial solids volume fraction used in PIC iterations to | String | "nth_eps" | | | approximate the volume fraction at the end of the time step, | | | -| | :math:t^{n+1}. | | | +| | :math:`t^{n+1}` | | | | | | | | | | Options (case-insensitive): | | | | | | | |