diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 20083b4643dfd694b5efa7523b22b29fbe64e033..d2790de5d67827f50c78e4e39f652d83dbef4016 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -27,7 +27,7 @@ The type of the boundary conditions in the BC region must be defined with the pr +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ -| [region] | Specify boundary condition type. | String | None | +| [region_name] | Specify boundary condition type. | String | None | | | | | | | | Options: | | | | | | | | @@ -45,7 +45,7 @@ Fluid settings ~~~~~~~~~~~~~~ For each boundary condition region, the fluid inputs are defined -using the prefix ``bc.[region].[fluid]``: +using the prefix ``bc.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ @@ -68,8 +68,8 @@ using the prefix ``bc.[region].[fluid]``: | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| species.[species_name] | Species 'species_name' mass fraction [required if solve_species=1 | Real | 0 | -| | and bc_region_type='mi' or 'pi']. | | | +| species.[species_name] | Species `species_name` mass fraction [required if `solve_species`=1 | Real | 0 | +| | and `bc_region_type`=`mi` or `pi`]. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. @@ -135,7 +135,7 @@ tridimensional). We recall that, on the remaining part of the EBs, homogeneous Neumann boundary conditions are assumed by default. In the following table there is a list of the possible entries for EB boundary -conditions. Each entry must be preceded by the prefix ``bc.[region]`` +conditions. Each entry must be preceded by the prefix ``bc.[region_name]`` +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -159,7 +159,7 @@ on an embedeed boundary. We recall that, on the remaining part of the EBs, no slip velocity conditions are assumed by default. In the following table is a list of the possible entries for inflow EB boundary -conditions. Each entry must be preceded by the prefix ``bc.[region]``. Like traditional mass +conditions. Each entry must be preceded by the prefix ``bc.[region_name]``. Like traditional mass inflows, the fluid temperature, pressure, and species composition must be provided when appropriate. diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index c29115a0cbf686274326acea077cbe981d7eec02..1e33b090d4473f81941e3ed7cf051479ecea66ab 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -26,7 +26,7 @@ Fluid settings ~~~~~~~~~~~~~~ For each initial condition region, the fluid inputs are defined -using the compound prefix ``ic.[region].[fluid]``: +using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -39,7 +39,7 @@ using the compound prefix ``ic.[region].[fluid]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| species.[species_name] | Mass fraction of 'species_name' | Real | 0 | +| species.[species_name] | Mass fraction of `species_name` | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ @@ -49,7 +49,7 @@ Solids settings ~~~~~~~~~~~~~~~ For each initial condition region, general solids inputs are defined -using the compound prefix ``ic.[region]``: +using the compound prefix ``ic.[region_name]``: +----------------------+------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -74,7 +74,7 @@ using the compound prefix ``ic.[region]``: +----------------------+------------------------------------------------------------------+-------------+-----------+ For each initial condition region, the solid inputs are defined -using the compound prefix ``ic.[region].[solid]``: +using the compound prefix ``ic.[region_name].[solid_name]``: Note that diameter distributions must define a weighting type, please refer to :ref:`ReferenceParticleDistributions `. @@ -85,7 +85,7 @@ please refer to :ref:`ReferenceParticleDistributions ` by the @@ -83,7 +83,7 @@ mesh refinement algorithm and are only applicable when ``amr.max_level > 0``. | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | grid_eff | Threshold value to ensure grids do not contain too large a fraction | Real | 0.7 | -| | of un-tagged cells. | | | +| | of untagged cells. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | n_error_buf | Controls the number of tagged cells before grids are defined. Used | Int | 1 | | | to ensure coarse/fine boundaries are not too close to tagged cells. | | | diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index d137449cd3b2592a8961c6ae8133b278a1b3356c..3f09d1ed4affc63f70fcb2241a573e3985c187b3 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -286,7 +286,7 @@ The following inputs are defined using the prefix ``mfix``: | | | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | max_solids_volume_fraction | Threshold solids volume fraction for `MaxPack` redistribution. | Real | 0.6 | -| | Redistribution of transferred quantities **only** occurs when the | | | +| | Redistribution of transferred quantities only occurs when the | | | | | solids volume fraction of a cell exceeds this value. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | deposition_redist_vfrac | Threshold geometric volume fraction ``StateRedist`` redistribution. | Real | 0.1 | @@ -303,49 +303,51 @@ Fluid-particle drag The following input is defined using the prefix ``mfix.drag``: -.. |VirtualMass_Eq| replace:: :math:`\mathbf{F}_p^{vm} = -C_p^{vm}\rho_f \left( \frac{D\mathbf{u}_f}{Dt} - \frac{d\mathbf{u}_p}{dt}\right)\mathcal{V}_p` - -.. |VM_Zuber_Eq| replace:: :math:`C_p^{vm} = \frac{1}{2}\frac{1+2\varepsilon_p}{1-\varepsilon_p}` - -.. |VM_Nijssen_Eq| replace:: :math:`\begin{split}C_p^{vm} =& C_0^{vm} \\ &+ \sum_{k=1}^3\left\{ \left[ a_{k,0} + a_{k,1} \ln \left( \frac{\rho_p}{\rho_f} \right) \right] \varepsilon_p^k \right\}\end{split}` - -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+==========================+=======================================================================+=============+===========+ -| model | Fluid-particle drag model. Options: | String | None | -| | | | | -| | * ``WenYu`` :cite:p:`Wen66` | | | -| | * ``Gidaspow`` :cite:p:`ding90,Lat00` | | | -| | * ``BVK2`` :cite:p:`Bee07,Bee071,tenneti11,tang15` | | | -| | * ``SyamOBrien`` :cite:p:`syam88` | | | -| | * ``UserDrag`` | | | -| | | | | -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| model.SyamOBrien.c1 | Fitting parameters for ``SyamOBrien`` drag model | Real | None | -| model.SyamOBrien.d1 | | | | -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| include_divtau | Interpolate the fluid shear stress to particles and include in the | Int | 0 | -| | fluid-particle drag force. The force is applied to the fluid by | | | -| | multiplying the shear stress by fluid volume fraction. | | | -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| virtual_mass | Include virtual mass force in fluid-particle momentum transfer. | String | None | -| | The virtual mass force is not included by default. | | | -| | | | | -| | |VirtualMass_Eq| | | | -| | | | | -| | * ``Null`` - zero virtual mass coefficient, :math:`C_p^{vm}=0` | | | -| | * ``Constant`` - specified constant coefficient | | | -| | * ``Zuber`` - :cite:p:`zuber64` | | | -| | | | | -| | |VM_Zuber_Eq| | | | -| | | | | -| | * ``Nijssen`` - :cite:p:`nijssen20` | | | -| | | | | -| | |VM_Nijssen_Eq| | | | -| | | | | -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| virtual_mass.constant | Constant virtual-mass coefficient. | Real | 0.5 | -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +.. |VirtualMass_Eq| replace:: :math:`\mathbf{F}_p,vm = -C_p,vm \rho_f \left( \frac{D\mathbf{u}_f}{Dt} - \frac{d\mathbf{u}_p}{dt}\right)\mathcal{V}_p` + +.. |VM_Zuber_Eq| replace:: :math:`C_p,vm = (\frac{1}{2})\frac{(1+2\varepsilon_p)}{(1-\varepsilon_p)}` + +.. |VM_Nijssen_Eq| replace:: :math:`\begin{split}C_p,vm =& C_0,vm \\ &+ \sum_{k=1}^3 \left\left[a_{k,0} + a_{k,1} \ln\left(\frac{\rho_p}{\rho_f}\right)\right] \varepsilon_p^k \right\end{split}` + ++--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++==========================+===============================================================================+=============+===========+ +| model | Fluid-particle drag model. Options: | String | None | +| | | | | +| | * ``WenYu`` :cite:p:`Wen66` | | | +| | * ``Gidaspow`` :cite:p:`ding90,Lat00` | | | +| | * ``BVK2`` :cite:p:`Bee07,Bee071,tenneti11,tang15` | | | +| | * ``SyamOBrien`` :cite:p:`syam88` | | | +| | * ``UserDrag`` | | | +| | | | | ++--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ +| model.SyamOBrien.c1 | Fitting parameters for ``SyamOBrien`` drag model | Real | None | +| model.SyamOBrien.d1 | | | | ++--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ +| include_divtau | Interpolate the fluid shear stress to particles and include in the | Int | 0 | +| | fluid-particle drag force. The force is applied to the fluid by | | | +| | multiplying the shear stress by fluid volume fraction. | | | ++--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ +| virtual_mass | Include virtual mass force in fluid-particle momentum transfer. | String | None | +| | The virtual mass force is not included by default. | | | +| | | | | +| | |VirtualMass_Eq| | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``None`` - virtual mass force calculation is skipped | | | +| | * ``Null`` - zero virtual mass coefficient, :math:`C_p,vm = 0` (for testing) | | | +| | * ``Constant`` - specified constant coefficient | | | +| | * ``Zuber`` - :cite:p:`zuber64` | | | +| | | | | +| | |VM_Zuber_Eq| | | | +| | | | | +| | * ``Nijssen`` - :cite:p:`nijssen20` | | | +| | | | | +| | |VM_Nijssen_Eq| | | | ++--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ +| virtual_mass.constant | Constant virtual-mass coefficient. | Real | 0.5 | ++--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ .. note:: @@ -365,6 +367,8 @@ The following input is defined using the prefix ``mfix.convection``: +===================+=======================================================================+=============+==============+ | model | Fluid-particle heat transfer coefficient model. | String | RanzMarshall | | | | | | +| | Options: | | | +| | | | | | | * ``RanzMarshall`` :cite:p:`ranz52` | | | | | * ``Gunn`` :cite:p:`gunn78` | | | | | * ``NullConvection`` - disable fluid-particle heat transfer | | | diff --git a/docs/source_docs/user_guide/inputs/output/monitors.rst b/docs/source_docs/user_guide/inputs/output/monitors.rst index 302af84e6373414f06a29d181057d4027d8f0fc7..785406730b48344b43b4134333b0befe51dc9c6b 100644 --- a/docs/source_docs/user_guide/inputs/output/monitors.rst +++ b/docs/source_docs/user_guide/inputs/output/monitors.rst @@ -7,13 +7,13 @@ Data (such as volume fraction, pressure, velocity, etc.) for a given monitor region is written to a CSV file while the solver is running. To define monitors, the following inputs must be preceded by the prefix ``mfix``: -+--------------------+------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+====================+======================================================+=============+===========+ -| monitors | Names of the monitors to be computed | Strings | None | -+--------------------+------------------------------------------------------+-------------+-----------+ -| monitors.[monitor] | Monitor type | String | None | -+--------------------+------------------------------------------------------+-------------+-----------+ ++-------------------------+------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++=========================+======================================================+=============+===========+ +| monitors | Names of the monitors to be computed | Strings | None | ++-------------------------+------------------------------------------------------+-------------+-----------+ +| monitors.[monitor_name] | Monitor type | String | None | ++-------------------------+------------------------------------------------------+-------------+-----------+ .. code-block:: none @@ -31,11 +31,11 @@ inputs. A Monitor region is a single point, plane, or volume. Multiple regions cannot be combined for a monitor. The following inputs must be preceded by the prefix ``mfix.monitors``: -+------------------+-----------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+==================+=======================================================================+=============+===========+ -| [monitor].region | Define the region in which the monitor will be computed | String | None | -+------------------+-----------------------------------------------------------------------+-------------+-----------+ ++-----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++=======================+=======================================================================+=============+===========+ +| [monitor_name].region | Define the region in which the monitor will be computed | String | None | ++-----------------------+-----------------------------------------------------------------------+-------------+-----------+ .. code-block:: none @@ -53,36 +53,36 @@ output file is in Comma Separated Value (CSV) format. The first line of the file provides header information. The following inputs must be preceded by the prefix ``mfix.monitors``: -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+===============================+==========================================================+=============+===========+ -| [monitor].plot_file | Name of the plot file for monitor output. | String | None | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].plot_int | Frequency for saving monitored data to output file. | Int | -1 | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].plot_per_approx | Define the approximated simulation time at which saving | Real | 0 | -| | monitored data | | | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].output.openmode | Select open mode for the monitor output file. | String | app | -| | | | | -| | Options: | | | -| | | | | -| | * ``app`` - append to the file if it already exists | | | -| | * ``trunc`` - overwrite the output file if it exists | | | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].output.setw | Field width for output file. | Int | 0 | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].output.setfill | Fill character for output file. | Char | '' | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].output.setprecision | Sets the decimal precision to be used to format | Int | 0 | -| | floating-point values in the output file | | | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ -| [monitor].output.format | Sets the format flags. Options: | String | "" | -| | | | | -| | * ``defaultfloat`` | | | -| | * ``fixed`` | | | -| | * ``scientific`` | | | -+-------------------------------+----------------------------------------------------------+-------------+-----------+ ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++===================================+==========================================================+=============+===========+ +| [monitor_name].plot_file | Name of the plot file for monitor output. | String | None | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].plot_int | Frequency for saving monitored data to output file. | Int | -1 | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].plot_per_approx | Define the approximated simulation time at which saving | Real | 0 | +| | monitored data | | | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].output.openmode | Select open mode for the monitor output file. | String | app | +| | | | | +| | Options: | | | +| | | | | +| | * ``app`` - append to the file if it already exists | | | +| | * ``trunc`` - overwrite the output file if it exists | | | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].output.setw | Field width for output file. | Int | 0 | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].output.setfill | Fill character for output file. | Char | '' | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].output.setprecision| Sets the decimal precision to be used to format | Int | 0 | +| | floating-point values in the output file | | | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ +| [monitor_name].output.format | Sets the format flags. Options: | String | "" | +| | | | | +| | * ``defaultfloat`` | | | +| | * ``fixed`` | | | +| | * ``scientific`` | | | ++-----------------------------------+----------------------------------------------------------+-------------+-----------+ .. code-block:: none @@ -99,11 +99,11 @@ Monitor variables The variables to be monitored can be specified in the inputs by including the following input preceded by the prefix ``mfix.monitors``: -+---------------------+--------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+=====================+====================================================================+=============+===========+ -| [monitor].variables | Define which variables are to be monitored by this monitor | String | None | -+---------------------+--------------------------------------------------------------------+-------------+-----------+ ++-------------------------+--------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++=========================+====================================================================+=============+===========+ +| [monitor_name].variables| Define which variables are to be monitored by this monitor | String | None | ++-------------------------+--------------------------------------------------------------------+-------------+-----------+ .. code-block:: none @@ -137,66 +137,66 @@ Symbol Description The following table lists all the fluid phase variables that can be monitored: -+--------------------------+-----------------------------------------------------------------------------------------+ -| | Description | -+==========================+=========================================================================================+ -| ones | value of :math:`\phi_{ijk}` is set to 1 in each fluid cell | -+--------------------------+-----------------------------------------------------------------------------------------+ -| ep_g | fluid volume fraction | -+--------------------------+-----------------------------------------------------------------------------------------+ -| p_g | fluid pressure | -+--------------------------+-----------------------------------------------------------------------------------------+ -| ro_g | fluid density | -+--------------------------+-----------------------------------------------------------------------------------------+ -| trac | tracer | -+--------------------------+-----------------------------------------------------------------------------------------+ -| vel_g | fluid velocity (all three components) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| vel_g_[x/y/z] | x, y, or z component of the fluid velocity | -+--------------------------+-----------------------------------------------------------------------------------------+ -| gp | fluid pressure gradient (all three components) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| gp_[x/y/z] | x, y, or z component of the fluid pressure gradient | -+--------------------------+-----------------------------------------------------------------------------------------+ -| T_g | fluid temperature | -+--------------------------+-----------------------------------------------------------------------------------------+ -| h_g | fluid enthalpy | -+--------------------------+-----------------------------------------------------------------------------------------+ -| X_gk | fluid species mass fractions (monitor all the fluid species) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| X_gk_[species] | fluid "species" mass fraction (only species "species" is monitored) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| vort | fluid vorticity (all three components) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| vort[x/y/z] | x, y, or z component of the fluid vorticity | -+--------------------------+-----------------------------------------------------------------------------------------+ -| txfr_velocity | interphase velocity transferred to the fluid (all three components) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| txfr_vel_[x/y/z] | x, y, or z component of the interphase velocity transferred to the fluid | -+--------------------------+-----------------------------------------------------------------------------------------+ -| txfr_beta | drag coefficient | -+--------------------------+-----------------------------------------------------------------------------------------+ -| txfr_gammaTp | convection coefficient multiplied by the solids temperature | -+--------------------------+-----------------------------------------------------------------------------------------+ -| txfr_gamma | convection coefficient | -+--------------------------+-----------------------------------------------------------------------------------------+ -| chem_txfr_X_gk | rate of mass transferred to the fluid phase due to heterogeneous chemical reactions | -| | (monitor all the fluid species) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| chem_txfr_X_gk_[species] | fluid "species" rate of mass transferred due to heterogeneous chemical reactions | -| | (only species "species" is monitored) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| chem_txfr_velocity | rate of velocity transferred to the fluid phase due to heterogeneous chemical reactions | -| | (all three components) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| chem_txfr_vel_[x/y/z] | x, y, or z component of the rate of velocity transferred due to heterogeneous reactions | -+--------------------------+-----------------------------------------------------------------------------------------+ -| chem_txfr_h | rate of enthalpy transferred to the fluid phase due to heterogeneous chemical reactions | -+--------------------------+-----------------------------------------------------------------------------------------+ -| divtau | divergence of the viscous stress tensor (all three components) | -+--------------------------+-----------------------------------------------------------------------------------------+ -| divtau_[x/y/z] | x, y, or z component of the divergence of the viscous stress tensor | -+--------------------------+-----------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------+ +| | Description | ++==============================+=========================================================================================+ +| ones | value of :math:`\phi_{ijk}` is set to 1 in each fluid cell | ++------------------------------+-----------------------------------------------------------------------------------------+ +| ep_g | fluid volume fraction | ++------------------------------+-----------------------------------------------------------------------------------------+ +| p_g | fluid pressure | ++------------------------------+-----------------------------------------------------------------------------------------+ +| ro_g | fluid density | ++------------------------------+-----------------------------------------------------------------------------------------+ +| trac | tracer | ++------------------------------+-----------------------------------------------------------------------------------------+ +| vel_g | fluid velocity (all three components) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| vel_g_[x/y/z] | x, y, or z component of the fluid velocity | ++------------------------------+-----------------------------------------------------------------------------------------+ +| gp | fluid pressure gradient (all three components) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| gp_[x/y/z] | x, y, or z component of the fluid pressure gradient | ++------------------------------+-----------------------------------------------------------------------------------------+ +| T_g | fluid temperature | ++------------------------------+-----------------------------------------------------------------------------------------+ +| h_g | fluid enthalpy | ++------------------------------+-----------------------------------------------------------------------------------------+ +| X_gk | fluid species mass fractions (monitor all the fluid species) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| X_gk_[species_name] | fluid `species_name` mass fraction (only species `species_name` is monitored) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| vort | fluid vorticity (all three components) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| vort[x/y/z] | x, y, or z component of the fluid vorticity | ++------------------------------+-----------------------------------------------------------------------------------------+ +| txfr_velocity | interphase velocity transferred to the fluid (all three components) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| txfr_vel_[x/y/z] | x, y, or z component of the interphase velocity transferred to the fluid | ++------------------------------+-----------------------------------------------------------------------------------------+ +| txfr_beta | drag coefficient | ++------------------------------+-----------------------------------------------------------------------------------------+ +| txfr_gammaTp | convection coefficient multiplied by the solids temperature | ++------------------------------+-----------------------------------------------------------------------------------------+ +| txfr_gamma | convection coefficient | ++------------------------------+-----------------------------------------------------------------------------------------+ +| chem_txfr_X_gk | rate of mass transferred to the fluid phase due to heterogeneous chemical reactions | +| | (monitor all the fluid species) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| chem_txfr_X_gk_[species_name]| fluid `species_name` rate of mass transferred due to heterogeneous chemical reactions | +| | (only species `species_name` is monitored) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| chem_txfr_velocity | rate of velocity transferred to the fluid phase due to heterogeneous chemical reactions | +| | (all three components) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| chem_txfr_vel_[x/y/z] | x, y, or z component of the rate of velocity transferred due to heterogeneous reactions | ++------------------------------+-----------------------------------------------------------------------------------------+ +| chem_txfr_h | rate of enthalpy transferred to the fluid phase due to heterogeneous chemical reactions | ++------------------------------+-----------------------------------------------------------------------------------------+ +| divtau | divergence of the viscous stress tensor (all three components) | ++------------------------------+-----------------------------------------------------------------------------------------+ +| divtau_[x/y/z] | x, y, or z component of the divergence of the viscous stress tensor | ++------------------------------+-----------------------------------------------------------------------------------------+ Uniform scalar field @@ -512,7 +512,7 @@ The following table lists all the solids phase variables that can be monitored: +--------------------------+-----------------------------------------------------------------------------------------+ | X_sn | particles species mass fractions (for all the solids species) | +--------------------------+-----------------------------------------------------------------------------------------+ -| X_sn_[species] | solids "species" mass fraction (only species "species" is monitored) | +| X_sn_[species_name] | solids `species_name` fraction (only species `species_name` is monitored) | +--------------------------+-----------------------------------------------------------------------------------------+ | txfr_velocity | rate of velocity transferred to the fluid phase due to heterogeneous chemical reactions | | | (all three components) | @@ -523,8 +523,8 @@ The following table lists all the solids phase variables that can be monitored: +--------------------------+-----------------------------------------------------------------------------------------+ | txfr_X_sn | rate of mass transferred due to heterogeneous chemical reactions (for all the species) | +--------------------------+-----------------------------------------------------------------------------------------+ -| txfr_X_sn_[species] | solids "species" rate of transfer due to heterogeneous reactions (only species | -| | "species" is monitored) | +| txfr_X_sn_[species_name] | solids `species_name` rate of transfer due to heterogeneous reactions (only species | +| | `species_name` is monitored) | +--------------------------+-----------------------------------------------------------------------------------------+ @@ -633,17 +633,17 @@ Volume-weighted average Flow rates ~~~~~~~~~~ -For Lagrangian monitors of type FlowRate, the flow plane must be specified in -the inputs and it must be defined by one of the regions defined in the regions -inputs. The following input for a monitor [monitor] of type FlowRate can be +For Lagrangian monitors of type `FlowRate`, the flow plane must be specified +and it must be defined by one of the regions defined in the regions +inputs. The following input for a monitor [monitor_name] of type `FlowRate` can be used, preceded by the prefix ``mfix.monitors``: -+------------------+-----------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+==================+=======================================================================+=============+===========+ -| [monitor].plane | Defines the plane through which the flow rate of the particles in the | String | None | -| | monitoring region [region] will be computed | | | -+------------------+-----------------------------------------------------------------------+-------------+-----------+ ++---------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++=====================+=======================================================================+=============+===========+ +| [monitor_name].plane| Defines the plane through which the flow rate of the particles in the | String | None | +| | monitoring region [region_name] will be computed. | | | ++---------------------+-----------------------------------------------------------------------+-------------+-----------+ Flow rate monitors for Lagrangian particles (DEM/PIC) are only valid for area diff --git a/docs/source_docs/user_guide/inputs/output/plotting.rst b/docs/source_docs/user_guide/inputs/output/plotting.rst index 2da4b06a6a4ccc6da7bb7b8844d285d8971c6e64..b6a21411396206fe165a95844d04536f948624e0 100644 --- a/docs/source_docs/user_guide/inputs/output/plotting.rst +++ b/docs/source_docs/user_guide/inputs/output/plotting.rst @@ -118,55 +118,55 @@ The following inputs must be preceded by the prefix ``mfix.solids`` and allow to 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 | String | | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region] | Specify which solids phases will be plotted | String | | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plot_int | Specify timestep frequency for plotting the file | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plot_per_approx | Specify time interval frequency for plotting the file | Real | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_regtest | Plot all variables (overrides all other plot flags) | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_cp_s | Plot particle specific heat coefficient | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_drag_p | Plot particle drag force | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_h_s_txfr | Plot particle interphase enthalpy transfer | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_mass | Plot particle mass | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_mass_sn_txfr | Plot particle interphase mass transfer | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_omega_p | Plot particle angular velocity | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_omoi | Plot inverse of particle momentum of inertia | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_phase | Plot particle phase | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_radius | Plot particle radius | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_ro_p | Plot particle density | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_state | Plot particle state | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_statwt | Plot particle statistical weight | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_T_p | Plot particle temperature | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_vel_p | Plot particle velocity | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_vel_s_txfr | Plot particle interphase velocity transfer | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_volume | Plot particle volume | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ -| [region].plt_X_s | Plot particle species mass fractions | Int | 0 | -+---------------------------+-----------------------------------------------------------------+-------------+-----------+ - -For each region with name [region] specified in the inputs, it will be saved a plotfile with name "partsXXXXX_[region]", where XXXXX stands for the timestep number. ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++================================+=================================================================+=============+===========+ +| regions | Specify regions that will be used for plotfiles | Strings | | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name] | Specify which solids phases will be plotted | String | | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plot_int | Specify timestep frequency for plotting the file | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plot_per_approx | Specify time interval frequency for plotting the file | Real | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_regtest | Plot all variables (overrides all other plot flags) | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_cp_s | Plot particle specific heat coefficient | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_drag_p | Plot particle drag force | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_h_s_txfr | Plot particle interphase enthalpy transfer | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_mass | Plot particle mass | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_mass_sn_txfr | Plot particle interphase mass transfer | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_omega_p | Plot particle angular velocity | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_omoi | Plot inverse of particle momentum of inertia | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_phase | Plot particle phase | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_radius | Plot particle radius | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_ro_p | Plot particle density | Int | 0 | ++--------------------------------+-----------------------------------------------------------------+-------------+-----------+ +| [region_name].plt_state | Plot particle state | 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_vel_p | Plot particle velocity | 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_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. Below is an example for specifying the inputs to plot solids data in a given diff --git a/docs/source_docs/user_guide/inputs/output/reports.rst b/docs/source_docs/user_guide/inputs/output/reports.rst index c722d116da65a6ac2198eb1f0b53adc67f89727c..f69bc6388a50b3b9c1b05050972f1043f8d02341 100644 --- a/docs/source_docs/user_guide/inputs/output/reports.rst +++ b/docs/source_docs/user_guide/inputs/output/reports.rst @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix.reports``: +--------------------+------------------------------------------------------+-------------+-----------+ -The following inputs are defined using the prefix ``mfix.reports.diameter.[report]``: +The following inputs are defined using the prefix ``mfix.reports.diameter.[report_name]``: +--------------------+------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | diff --git a/docs/source_docs/user_guide/inputs/porous_media.rst b/docs/source_docs/user_guide/inputs/porous_media.rst index 871ac657bc4aa289d2832c076faaaade02d6115e..0de498418d98d9c6e94b706e5b29e86837a919cb 100644 --- a/docs/source_docs/user_guide/inputs/porous_media.rst +++ b/docs/source_docs/user_guide/inputs/porous_media.rst @@ -15,18 +15,18 @@ source term, :math:`\boldsymbol{S}_{pm}`, to the fluid momentum equation. The following inputs are defined using the prefix ``pm``: -+--------------------------+------------------------------------------------------------------------------+----------+-----------+ -| | Description | Type | Default | -+==========================+==============================================================================+==========+===========+ -| regions | Regions used to define porous media. | Strings | None | -+--------------------------+------------------------------------------------------------------------------+----------+-----------+ -| [region].volfrac | Solids volume fraction of the porous media region. | Real | None | -+--------------------------+------------------------------------------------------------------------------+----------+-----------+ -| [region].c1 | Porous media permeabilty constant for the source term in fluid | Real | None | -| | momentum equation. | | | -+--------------------------+------------------------------------------------------------------------------+----------+-----------+ -| [region].c2 | Porous media inertial resistance factor for the source term in fluid | Real | None | -| | momentum equation. | | | -+--------------------------+------------------------------------------------------------------------------+----------+-----------+ -| [region].allow_particles | Allow particles to flow through the porous media region. | Int | 0 | -+--------------------------+------------------------------------------------------------------------------+----------+-----------+ ++-------------------------------+------------------------------------------------------------------------------+----------+-----------+ +| | Description | Type | Default | ++===============================+==============================================================================+==========+===========+ +| regions | Regions used to define porous media. | Strings | None | ++-------------------------------+------------------------------------------------------------------------------+----------+-----------+ +| [region_name].volfrac | Solids volume fraction of the porous media region. | Real | None | ++-------------------------------+------------------------------------------------------------------------------+----------+-----------+ +| [region_name].c1 | Porous media permeabilty constant for the source term in fluid | Real | None | +| | momentum equation. | | | ++-------------------------------+------------------------------------------------------------------------------+----------+-----------+ +| [region_name].c2 | Porous media inertial resistance factor for the source term in fluid | Real | None | +| | momentum equation. | | | ++-------------------------------+------------------------------------------------------------------------------+----------+-----------+ +| [region_name].allow_particles | Allow particles to flow through the porous media region. | Int | 0 | ++-------------------------------+------------------------------------------------------------------------------+----------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/regions.rst b/docs/source_docs/user_guide/inputs/regions.rst index 67d8c82e434265a96d03032908bf904042c366d4..2b06efaf7d3640a6509d87d0c925893151ebb319 100644 --- a/docs/source_docs/user_guide/inputs/regions.rst +++ b/docs/source_docs/user_guide/inputs/regions.rst @@ -5,15 +5,15 @@ Regions definitions Regions are used to define sections of the domain. They may be either boxes, planes or points. They are used in defining initial and boundary conditions. -+---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+=====================+=======================================================================+=============+===========+ -| mfix.regions | Names given to regions. | Strings | None | -+---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| regions.[region].lo | Low corner of physical region (physical, not index space) | Reals | 0 0 0 | -+---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| regions.[region].hi | High corner of physical region (physical, not index space) | Reals | 0 0 0 | -+---------------------+-----------------------------------------------------------------------+-------------+-----------+ ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++==========================+=======================================================================+=============+===========+ +| mfix.regions | Names given to regions. | Strings | None | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| regions.[region_name].lo | Low corner of physical region (physical, not index space) | Reals | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| regions.[region_name].hi | High corner of physical region (physical, not index space) | Reals | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ Below is an example for specifying two regions.