Loading docs/source_docs/user_guide/inputs/boundary_conditions.rst +6 −6 Original line number Diff line number Diff line Loading @@ -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: | | | | | | | | Loading @@ -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]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading @@ -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. Loading Loading @@ -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 | Loading @@ -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. Loading docs/source_docs/user_guide/inputs/initial_conditions.rst +5 −5 Original line number Diff line number Diff line Loading @@ -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 | Loading @@ -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 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading @@ -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 | Loading @@ -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 <ReferenceParticleDistributions>`. Loading @@ -85,7 +85,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | temperature | temperature | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of 'species_name' | Real | 0 | | species.[species_name] | Mass fraction of `species_name` | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +2 −2 Original line number Diff line number Diff line Loading @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``amr``: | max_level | Maximum level of refinement. The default value, 0, means that there | Int | 0 | | | is one cell size covering the entire domain (i.e., single-level). | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | n_cell | Number of cells at level 0 in each coordinate direction | Ints | 0 0 0 | | n_cell | Number of cells at level 0 in each coordinate direction. | Ints | 0 0 0 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The level 0 mesh spacing is computed for each direction by dividing the :ref:`domain length<InputsTable_domain>` by the Loading Loading @@ -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. | | | Loading docs/source_docs/user_guide/inputs/model_options.rst +17 −13 Original line number Diff line number Diff line Loading @@ -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 | Loading @@ -303,15 +303,15 @@ 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` .. |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_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}` .. |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` | | | Loading @@ -320,20 +320,23 @@ The following input is defined using the prefix ``mfix.drag``: | | * ``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` | | | | | 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` | | | | | | | | Loading @@ -342,10 +345,9 @@ The following input is defined using the prefix ``mfix.drag``: | | * ``Nijssen`` - :cite:p:`nijssen20` | | | | | | | | | | |VM_Nijssen_Eq| | | | | | | | | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ | virtual_mass.constant | Constant virtual-mass coefficient. | Real | 0.5 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ .. note:: Loading @@ -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 | | | Loading docs/source_docs/user_guide/inputs/output/monitors.rst +74 −74 File changed.Preview size limit exceeded, changes collapsed. Show changes Loading
docs/source_docs/user_guide/inputs/boundary_conditions.rst +6 −6 Original line number Diff line number Diff line Loading @@ -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: | | | | | | | | Loading @@ -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]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading @@ -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. Loading Loading @@ -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 | Loading @@ -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. Loading
docs/source_docs/user_guide/inputs/initial_conditions.rst +5 −5 Original line number Diff line number Diff line Loading @@ -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 | Loading @@ -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 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading @@ -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 | Loading @@ -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 <ReferenceParticleDistributions>`. Loading @@ -85,7 +85,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | temperature | temperature | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of 'species_name' | Real | 0 | | species.[species_name] | Mass fraction of `species_name` | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading
docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +2 −2 Original line number Diff line number Diff line Loading @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``amr``: | max_level | Maximum level of refinement. The default value, 0, means that there | Int | 0 | | | is one cell size covering the entire domain (i.e., single-level). | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | n_cell | Number of cells at level 0 in each coordinate direction | Ints | 0 0 0 | | n_cell | Number of cells at level 0 in each coordinate direction. | Ints | 0 0 0 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The level 0 mesh spacing is computed for each direction by dividing the :ref:`domain length<InputsTable_domain>` by the Loading Loading @@ -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. | | | Loading
docs/source_docs/user_guide/inputs/model_options.rst +17 −13 Original line number Diff line number Diff line Loading @@ -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 | Loading @@ -303,15 +303,15 @@ 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` .. |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_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}` .. |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` | | | Loading @@ -320,20 +320,23 @@ The following input is defined using the prefix ``mfix.drag``: | | * ``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` | | | | | 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` | | | | | | | | Loading @@ -342,10 +345,9 @@ The following input is defined using the prefix ``mfix.drag``: | | * ``Nijssen`` - :cite:p:`nijssen20` | | | | | | | | | | |VM_Nijssen_Eq| | | | | | | | | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ | virtual_mass.constant | Constant virtual-mass coefficient. | Real | 0.5 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ .. note:: Loading @@ -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 | | | Loading
docs/source_docs/user_guide/inputs/output/monitors.rst +74 −74 File changed.Preview size limit exceeded, changes collapsed. Show changes
