diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 198894b7c8cc16fe15f634faaf65bba2ced54ee4..dd689c54bb3aa31b8ceb9b34d4d24369831e8608 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -27,210 +27,227 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill .. |Sato_Eq| replace:: :math:`\mu_{pit} = C d_s \rho \left|\boldsymbol{u} - \boldsymbol{u_s}\right|` .. |eff_visc| replace:: :math:`\mu_{eff} = \mu_{mol} + \mu_{eddy} + \mu_{susp} + \mu_{pit}` - .. |mix_Eq| replace:: :math:`\mu_{mix} = \sum_{\alpha=1}^{N} \frac{X_{\alpha} \mu_{\alpha}}{\sum_{\beta} X_{\beta} \phi_{\alpha \beta}}` -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| | Description | Type | Default | -+============================================+============================================================+========+==========+ -| viscosity.molecular | Specify which molecular viscosity model to use. | String | None | -| | | | | -| | Options: | | | -| | | | | -| | * ``None`` - no viscosity model. | | | -| | * ``constant`` - constant viscosity | | | -| | * ``Sutherland`` :cite:p:`suth1893` - | | | -| | | | | -| | |Sutherland_Eq| | | | -| | | | | -| | * ``Reid`` :cite:p:`reid87` - | | | -| | | | | -| | |Reid_4parm_Eq| | | | -| | | | | -| | * ``mixture`` - a mixture viscosity is computed from | | | -| | :ref:`species viscosities` | | | -| | and local species mass fractions :cite:p:`bird06` | | | -| | | | | -| | |mix_Eq| | | | -| | | | | -| | A viscosity model is required if the fluid solver is | | | -| | enabled. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.molecular.constant | Constant fluid viscosity. | Real | 0 | -| | | | | -| | A value is required for ``constant`` viscosity model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.molecular.Sutherland.T_ref | Sutherland model reference temperature. | Real | 0 | -| | | | | -| | A value is required for ``Sutherland`` viscosity model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.molecular.Sutherland.mu_ref | Sutherland model reference viscosity at T_ref. | Real | 0 | -| | | | | -| | A value is required for ``Sutherland`` viscosity model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.molecular.Sutherland.S | Sutherland model temperature. | Real | 0 | -| | | | | -| | A value is required for ``Sutherland`` viscosity model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.molecular.Reid.A | Reid model constants. | Real | 0 | -| viscosity.molecular.Reid.B | | | | -| viscosity.molecular.Reid.C | Values are required for ``Reid`` viscosity model. | | | -| viscosity.molecular.Reid.D | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.eddy | Specify eddy viscosity model. | | | -| | | | | -| | Options: | | | -| | |String | None | -| | * ``None`` - No eddy viscosity model | | | -| | * ``Smagorinsky-Lilly`` :cite:p:`Smag63,Lilly66` | | | -| | * ``WALE`` :cite:p:`ducros98` | | | -| | * ``usr`` | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.eddy.Smagorinsky-Lilly.constant | Smagorinsky-Lilly constant which usually has values | Real | None | -| | between 0.1 and 0.2. | | | -| | | | | -| | A value is required when using the ``Smagorinsky-Lilly`` | | | -| | eddy viscosity model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.eddy.WALE.constant | WALE eddy viscosity model constant. | Real | 0.325 | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension | Specify suspension viscosity model of the form | String | None | -| | | | | -| | :math:`\mu_{susp} = \mu_{mol}(\mu^* - 1)` | | | -| | | | | -| | Options: | | | -| | | | | -| | * ``None`` - No eddy suspension model | | | -| | | | | -| | :math:`\mu^* = 1` | | | -| | | | | -| | * ``Einstein`` :cite:p:`einstein11` | | | -| | | | | -| | :math:`\mu^* = 1 + 2.5\varepsilon_s` | | | -| | | | | -| | * ``Brinkman`` :cite:p:`brinkman52,gibilaro07` | | | -| | | | | -| | :math:`\mu^* = (1-\varepsilon_s)^{-c}` | | | -| | | | | -| | * ``Roscoe`` :cite:p:`roscoe52,krieger59,maron56` | | | -| | | | | -| | :math:`\mu^* = (1-\varepsilon_s/c_1)^{-c_2}` | | | -| | | | | -| | * ``ChengLaw`` :cite:p:`cheng03` | | | -| | | | | -| | :math:`\mu^* = e^{2.5(1/(1-\varepsilon_s)^c-1)/c}` | | | -| | | | | -| | * ``Sato`` :cite:p:`sato81` | | | -| | | | | -| | |Sato_Eq| | | | -| | | | | -| | * ``Subramaniam`` :cite:p:`mehrabadi15` | | | -| | | | | -| | :math:`\mu_{pit} = C_\mu k_f^2 / \epsilon_f` | | | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension.Brinkman.constant | Constant for exponent in Brinkman suspension expression. | Real | None | -| | | | | -| | A value is required when using the ``Brinkman`` model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension.Roscoe.c1 | Constant for max packing in Roscoe suspension expression. | Real | None | -| | | | | -| | A value is required when using the ``Roscoe`` model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension.Roscoe.c2 | Constant for exponent in Roscoe suspension expression. | Real | None | -| | | | | -| | A value is required when using the ``Roscoe`` model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension.ChengLaw.constant | Constant for exponent in ChengLaw suspension expression. | Real | None | -| | | | | -| | A value is required when using the ``ChengLaw`` model. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension.Sato.constant | Constant for Sato suspension expression. | Real | 0.65 | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.suspension.Subramaniam.constant | Constant for Subramaniam suspension expression. | Real | 0.09 | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.max_effective_factor | Max limit of the effective viscosity as a factor of the | Real | 1.e6 | -| | molecular viscosity | | | -| | | | | -| | :math:`\mu_{eff} < fac*\mu_{mol}`, where | | | -| | |eff_visc| | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| species | Specify the species that constitute the fluid. | Strings| None | -| | | | | -| | All listed species must be properly defined. See the | | | -| | :ref:`species definition documentation` | | | -| | for additional details. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| molecular_weight | Constant fluid molecular weight. | Real | 0 | -| | | | | -| | A molecular weight should only be defined when using one | | | -| | of the ``IdealGas`` constraints and the species equations | | | -| | are not solved. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| specific_heat | Specify which specific heat model to use for the fluid. | String | None | -| | Options: | | | -| | | | | -| | * ``constant`` - the fluid has a constant specific heat | | | -| | | | | -| | * ``NASA7-poly`` the fluid specific heat is defined by | | | -| | NASA-7 polynomials. | | | -| | | | | -| | NASA7 polynomial format: | | | -| | | | | -| | :math:`c_p(T)/R = \sum_{i=0}^4 a_{i}T^{i}` | | | -| | | | | -| | Additional information on NASA-7 polynomials is provided | | | -| | in :ref:`species specific heats`. | | | -| | | | | -| | * ``mixture`` - a *mixture* specific heat is computed | | | -| | from :ref:`species specific heats` | | | -| | and local species mass fractions. | | | -| | | | | -| | :math:`c_{p,\mathrm{mixture}} = \sum_n X_n c_{p,n}` | | | -| | | | | -| | A specific heat model is required if advecting enthalpy. | | | -| | Furthermore, the model must be ``mixture`` if species | | | -| | equations are solved. | | | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| specific_heat.constant | Constant fluid specific heat | Real | 0 | -| | A value is required for ``constant`` specific heat model. | | | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| specific_heat.NASA7.a[i] | Specific heat polynomial coefficients. Polynomial | Real | None | -| | coefficients are required if the fluid specific heat | | | -| | model is ``NASA7-poly``. | | | -| | | | | -| | Additional information on NASA-7 polynomials is provided | | | -| | in :ref:`species specific heats`. | | | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| thermal_conductivity | Specify which thermal conductivity model to use for | String | None | -| | fluid. Options: | | | -| | | | | -| | * ``constant`` - the fluid has a constant thermal | | | -| | conductivity model | | | -| | | | | -| | A thermal conductivity model is required if advecting | | | -| | enthalpy. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| thermal_conductivity.constant | Constant fluid thermal conductivity. | Real | 0 | -| | A value is required for ``constant`` thermal conductivity | | | -| | model. | | | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| thermodynamic_pressure | Thermodynamic pressure. | Real | 0 | -| | A value is required when using the | | | -| | ``IdealGasClosedSystem`` constraint. If using the | | | -| | ``IdealGasOpenSystem`` constraint, then the value must | | | -| | match all specified outflow pressures. | | | -| | | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ -| reference_temperature | Reference temperature used to compute specific | Real | 298. | -| | enthalpy | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| | Description | Type | Default | ++============================================+================================================================+========+==========+ +| viscosity.molecular | Specify which molecular viscosity model to use. | String | None | +| | | | | +| | Options: | | | +| | | | | +| | * ``None`` - no viscosity model. | | | +| | * ``constant`` - constant viscosity | | | +| | * ``Sutherland`` :cite:p:`suth1893` - | | | +| | | | | +| | |Sutherland_Eq| | | | +| | | | | +| | * ``Reid`` :cite:p:`reid87` - | | | +| | | | | +| | |Reid_4parm_Eq| | | | +| | | | | +| | * ``mixture`` - a mixture viscosity is computed from | | | +| | :ref:`species viscosities` | | | +| | and local species mass fractions :cite:p:`bird06` | | | +| | | | | +| | |mix_Eq| | | | +| | | | | +| | A viscosity model is required if the fluid solver is | | | +| | enabled. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.molecular.constant | Constant fluid viscosity. | Real | 0 | +| | | | | +| | A value is required for ``constant`` viscosity model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.molecular.Sutherland.T_ref | Sutherland model reference temperature. | Real | 0 | +| | | | | +| | A value is required for ``Sutherland`` viscosity model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.molecular.Sutherland.mu_ref | Sutherland model reference viscosity at T_ref. | Real | 0 | +| | | | | +| | A value is required for ``Sutherland`` viscosity model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.molecular.Sutherland.S | Sutherland model temperature. | Real | 0 | +| | | | | +| | A value is required for ``Sutherland`` viscosity model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.molecular.Reid.A | Reid model constants. | Real | 0 | +| viscosity.molecular.Reid.B | | | | +| viscosity.molecular.Reid.C | Values are required for ``Reid`` viscosity model. | | | +| viscosity.molecular.Reid.D | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.eddy | Specify eddy viscosity model. | | | +| | | | | +| | Options: | | | +| | |String | None | +| | * ``None`` - No eddy viscosity model | | | +| | * ``Smagorinsky-Lilly`` :cite:p:`Smag63,Lilly66` | | | +| | * ``WALE`` :cite:p:`ducros98` | | | +| | * ``usr`` | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.eddy.Smagorinsky-Lilly.constant | Smagorinsky-Lilly constant which usually has values | Real | None | +| | between 0.1 and 0.2. | | | +| | | | | +| | A value is required when using the ``Smagorinsky-Lilly`` | | | +| | eddy viscosity model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.eddy.WALE.constant | WALE eddy viscosity model constant. | Real | 0.325 | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension | Specify suspension viscosity model of the form | String | None | +| | | | | +| | :math:`\mu_{susp} = \mu_{mol}(\mu^* - 1)` | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``None`` - No eddy suspension model | | | +| | | | | +| | :math:`\mu^* = 1` | | | +| | | | | +| | * ``Einstein`` :cite:p:`einstein11` | | | +| | | | | +| | :math:`\mu^* = 1 + 2.5\varepsilon_s` | | | +| | | | | +| | * ``Brinkman`` :cite:p:`brinkman52,gibilaro07` | | | +| | | | | +| | :math:`\mu^* = (1-\varepsilon_s)^{-c}` | | | +| | | | | +| | * ``Roscoe`` :cite:p:`roscoe52,krieger59,maron56` | | | +| | | | | +| | :math:`\mu^* = (1-\varepsilon_s/c_1)^{-c_2}` | | | +| | | | | +| | * ``ChengLaw`` :cite:p:`cheng03` | | | +| | | | | +| | :math:`\mu^* = e^{2.5(1/(1-\varepsilon_s)^c-1)/c}` | | | +| | | | | +| | * ``Sato`` :cite:p:`sato81` | | | +| | | | | +| | |Sato_Eq| | | | +| | | | | +| | * ``Subramaniam`` :cite:p:`mehrabadi15` | | | +| | | | | +| | :math:`\mu_{pit} = C_\mu k_f^2 / \epsilon_f` | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension.Brinkman.constant | Constant for exponent in Brinkman suspension expression. | Real | None | +| | | | | +| | A value is required when using the ``Brinkman`` model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension.Roscoe.c1 | Constant for max packing in Roscoe suspension expression. | Real | None | +| | | | | +| | A value is required when using the ``Roscoe`` model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension.Roscoe.c2 | Constant for exponent in Roscoe suspension expression. | Real | None | +| | | | | +| | A value is required when using the ``Roscoe`` model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension.ChengLaw.constant | Constant for exponent in ChengLaw suspension expression. | Real | None | +| | | | | +| | A value is required when using the ``ChengLaw`` model. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension.Sato.constant | Constant for Sato suspension expression. | Real | 0.65 | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.suspension.Subramaniam.constant | Constant for Subramaniam suspension expression. | Real | 0.09 | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| viscosity.max_effective_factor | Max limit of the effective viscosity as a factor of the | Real | 1.e6 | +| | molecular viscosity | | | +| | | | | +| | :math:`\mu_{eff} < fac*\mu_{mol}`, where | | | +| | |eff_visc| | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| species | Specify the species that constitute the fluid. | Strings| None | +| | | | | +| | All listed species must be properly defined. See the | | | +| | :ref:`species definition documentation` | | | +| | for additional details. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| molecular_weight | Constant fluid molecular weight. | Real | 0 | +| | | | | +| | A molecular weight should only be defined when using one | | | +| | of the ``IdealGas`` constraints and the species equations | | | +| | are not solved. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| specific_heat | Specify which specific heat model to use for the fluid. | String | None | +| | | | | +| | A specific heat model is required if advecting enthalpy. | | | +| | Furthermore, the model must be ``mixture`` if species | | | +| | equations are solved. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``constant`` - the fluid has a constant specific heat | | | +| | | | | +| | * ``NASA7-poly`` the fluid specific heat is defined by | | | +| | NASA-7 polynomials. | | | +| | | | | +| | NASA7 polynomial format: | | | +| | | | | +| | :math:`c_p(T)/R = \sum_{i=0}^4 a_{i}T^{i}` | | | +| | | | | +| | Additional information on NASA-7 polynomials is provided | | | +| | in :ref:`species specific heats`. | | | +| | | | | +| | * ``mixture`` - a *mixture* specific heat is computed | | | +| | from :ref:`species specific heats` | | | +| | and local species mass fractions. | | | +| | | | | +| | :math:`c_{p,\mathrm{mixture}} = \sum_n X_n c_{p,n}` | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| specific_heat.constant | Constant fluid specific heat | Real | 0 | +| | A value is required for ``constant`` specific heat model. | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| specific_heat.ignore_discontinuities | Ignore discontinuities in NASA-7 polynomials at transition | Int | 0 | +| | temperatures (``Tsplit``). More information is provided | | | +| | in :ref:`species specific heats`. | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| specific_heat.NASA7.a[i] | Specific heat polynomial coefficients. Polynomial | Reals | None | +| | coefficients are required if the fluid specific heat | | | +| | model is ``NASA7-poly``. | | | +| | | | | +| | Additional information on NASA-7 polynomials is provided | | | +| | in :ref:`species specific heats`. | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| specific_heat.NASA7.Tsplit | Defines the transition temperature between NASA-7 polynomials. | Reals | 1000 | +| | | | | +| | * Setting ``Tsplit = -1`` signifies that a single | | | +| | polynomial defines the specific heat and enthalpy for all | | | +| | temperatures. | | | +| | | | | +| | * Specifying ``N`` temperatures signifies that ``N+1`` | | | +| | polynomials are used to define the specific heat | | | +| | and enthalpy. | | | +| | | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| thermal_conductivity | Specify which thermal conductivity model to use for | String | None | +| | fluid. Options: | | | +| | | | | +| | * ``constant`` - the fluid has a constant thermal | | | +| | conductivity model | | | +| | | | | +| | A thermal conductivity model is required if advecting | | | +| | enthalpy. | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| thermal_conductivity.constant | Constant fluid thermal conductivity. | Real | 0 | +| | A value is required for ``constant`` thermal conductivity | | | +| | model. | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| thermodynamic_pressure | Thermodynamic pressure. | Real | 0 | +| | A value is required when using the | | | +| | ``IdealGasClosedSystem`` constraint. If using the | | | +| | ``IdealGasOpenSystem`` constraint, then the value must | | | +| | match all specified outflow pressures. | | | +| | | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ +| reference_temperature | Reference temperature used to compute specific | Real | 298. | +| | enthalpy | | | ++--------------------------------------------+----------------------------------------------------------------+--------+----------+ Example inputs diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 579419cece0724658eebdf91ee96c05bdb3ccc0b..5c1397c4fb070152884e813222231f1fd283a216 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -20,7 +20,7 @@ The following inputs are defined using the prefix ``ic``: | | * ``Volume`` - sort by volume of each IC region | | | | | * ``Priority`` - sort by specified priority value | | | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ -| [region_name].priority| Priority value for IC regions if ``ranking_type` == ``Priority`` | Int | Max | +| [region_name].priority| Priority value for IC regions if ``ranking_type`` == ``Priority`` | Int | Max | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index 7983264118309bf538d4b0b861f2c53203e148be..f5c0338ba9fd465299baf24528d4f64f16b67a74 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -13,8 +13,6 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+----------------------------------------------------------------------------+----------+---------------------+ | advect_enthalpy | Enable time evolution of fluid temperature and enthalpy. | Int | 0 | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| solve_species | Enable the time evolution of fluid species mass fractions. | Int | 0 | -+------------------------+----------------------------------------------------------------------------+----------+---------------------+ | constraint | Select low Mach number constraint. | String | IncompressibleFluid | | | | | | | | Options (case-insensitive): | | | @@ -310,45 +308,46 @@ The following input is defined using the prefix ``mfix.drag``: .. |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`` -- Syamlal-O'Brien :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 | -+--------------------------+-------------------------------------------------------------------------------+-------------+-----------+ ++--------------------------+-----------------------------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++==========================+=========================================================================================+=============+===========+ +| model | Fluid-particle drag model. Options: | String | None | +| | | | | +| | * ``WenYu``- Wen-Yu :cite:p:`Wen66` | | | +| | * ``Gidaspow`` :cite:p:`ding90,Lat00` | | | +| | * ``BVK2`` - Beetstra, van der Hoef, and Kuipers :cite:p:`Bee07,Bee071,tenneti11,tang15`| | | +| | * ``SyamOBrien`` - Syamlal-O'Brien :cite:p:`syam88` | | | +| | * ``UserDrag`` - User-supplied drag model | | | +| | | | | +| | | | | ++--------------------------+-----------------------------------------------------------------------------------------+-------------+-----------+ +| 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:: diff --git a/docs/source_docs/user_guide/inputs/solids_model.rst b/docs/source_docs/user_guide/inputs/solids_model.rst index 14364640d121eb489c63b8623cbade1174e8ca49..adfeaa0dd91e201e0967169b33f8df41f4a9eb91 100644 --- a/docs/source_docs/user_guide/inputs/solids_model.rst +++ b/docs/source_docs/user_guide/inputs/solids_model.rst @@ -9,71 +9,114 @@ Solids settings Enabling the solids solver and specifying options common to both DEM and PIC models. The following inputs are defined with the prefix ``solids``: -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| | Description | Type | Default | -+==========================================+=============================================================+==========+==========+ -| types | Specified name(s) of the solids types or None to disable | Strings | None | -| | the solids solver. The user-defined names are used to | | | -| | specify DEM and/or PIC model inputs. | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| molecular_weight | Value of constant solid molecular weight. | Real | 0 | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| density | Specify which density model to use for solids. | String | None | -| | | | | -| | Options (case-insensive): | | | -| | | | | -| | * ``None`` - solids density specified through initial and | | | -| | boundary conditions; | | | -| | * ``Mixture`` - solids density computed as a weighted | | | -| | average of the solid phase species densities. It requires | | | -| | constant :ref:`species densities` to | | | -| | be defined by the user. | | | -| | | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| specific_heat | Specify which specific heat model to use for solids. | String | constant | -| | | | | -| | Options: | | | -| | | | | -| | * ``constant`` - constant specific heat | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| specific_heat.constant | Constant solids specific heat value. | Real | 0 | -| | A value is required for ``constant`` specific heat model. | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| reference_temperature | Reference temperature used for specific enthalpy. | Real | 0 | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| species | Specify which species can constitute | Strings | None | -| | the solids phase. Defined species must | | | -| | be a subset of the species defined in ``species.solve`` | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| newton_solver.absolute_tol | Define absolute tolerance for damped Newton solver. | Real | 1.e-6 | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| newton_solver.relative_tol | Define relative tolerance for damped Newton solver. | Real | 1.e-6 | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| newton_solver.max_iterations | Define max number of iterations for damped Newton solver. | Int | 100 | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| thermal_conductivity | Specify which thermal conductivity model to use for solids. | String | constant | -| | Options: | | | -| | | | | -| | * ``constant`` - constant thermal conductivity | | | -| | | | | -| | A thermal conductivity model is not required for solids. | | | -| | Defining a thermal conductivity model enables conductive | | | -| | heat transfer for DEM. However, it has no effect for PIC | | | -| | solids heat transfer. | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| thermal_conductivity.constant | Constant solids thermal conductivity value. | Real | 0 | -| | A value is required for ``constant`` thermal conductivity | | | -| | model. | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| min_conduction_dist | The surface roughness separating two touching particles. | Real | 2.e-8 | -| | This value is used to remove the singularity that the | | | -| | particle-fluid-particle conduction model develops at | | | -| | the contact interface. | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ -| flpc | The fluid lens proportionality constant (flpc) is used to | Real | 0.4 | -| | calculate the radius of the fluid lens surrounding the | | | -| | particle for particle-fluid-particle conduction. | | | -+------------------------------------------+-------------------------------------------------------------+----------+----------+ ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| | Description | Type | Default | ++==========================================+==============================================================+==========+==========+ +| types | Specified name(s) of the solids types or None to disable | Strings | None | +| | the solids solver. The user-defined names are used to | | | +| | specify DEM and/or PIC model inputs. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| molecular_weight | Value of constant solid molecular weight. | Real | 0 | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| density | Specify which density model to use for solids. | String | None | +| | | | | +| | Options (case-insensive): | | | +| | | | | +| | * ``None`` - solids density specified through initial and | | | +| | boundary conditions; | | | +| | * ``Mixture`` - solids density computed as a weighted | | | +| | average of the solid phase species densities. It requires | | | +| | constant :ref:`species densities` to | | | +| | be defined by the user. | | | +| | | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| specific_heat | Specify which specific heat model to use for solids. | String | constant | +| | | | | +| | A specific heat model is required if advecting enthalpy. | | | +| | Furthermore, the model must be ``mixture`` if species | | | +| | equations are solved. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``constant`` - constant solid specific heat | | | +| | * ``NASA7-poly`` the solid specific heat is defined by | | | +| | NASA-7 polynomials. | | | +| | | | | +| | NASA7 polynomial format: | | | +| | | | | +| | :math:`c_p(T)/R = \sum_{i=0}^4 a_{i}T^{i}` | | | +| | | | | +| | Additional information on NASA-7 polynomials is provided | | | +| | in :ref:`species specific heats`. | | | +| | | | | +| | * ``mixture`` - a *mixture* specific heat is computed | | | +| | from :ref:`species specific heats` | | | +| | and local species mass fractions. | | | +| | | | | +| | :math:`c_{p,\mathrm{mixture}} = \sum_n X_n c_{p,n}` | | | +| | | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| specific_heat.constant | Constant solids specific heat value. | Real | 0 | +| | A value is required for ``constant`` specific heat model. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| specific_heat.ignore_discontinuities | Ignore discontinuities in NASA-7 polynomials at transition | Int | 0 | +| | temperatures (``Tsplit``). More information is provided in | | | +| | :ref:`species specific heats`. | | | +| | | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| specific_heat.NASA7.a[i] | Specific heat polynomial coefficients. Polynomial | Reals | None | +| | coefficients are required if the fluid specific heat | | | +| | model is ``NASA7-poly``. | | | +| | | | | +| | Additional information on NASA-7 polynomials is provided | | | +| | in :ref:`species specific heats`. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| specific_heat.NASA7.Tsplit | Defines the transition temperature between NASA-7 | Reals | 1000 | +| | polynomials. | | | +| | | | | +| | * Setting ``Tsplit = -1`` signifies that a single polynomial | | | +| | defines the specific heat and enthalpy for all | | | +| | temperatures. | | | +| | | | | +| | * Specifying ``N`` temperatures signifies that ``N+1`` | | | +| | polynomials are used to define the specific heat and | | | +| | enthalpy. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| reference_temperature | Reference temperature used for specific enthalpy. | Real | 0 | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| species | Specify which species can constitute | Strings | None | +| | the solids phase. Defined species must | | | +| | be a subset of the species defined in ``species.solve`` | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| newton_solver.absolute_tol | Define absolute tolerance for damped Newton solver. | Real | 1.e-6 | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| newton_solver.relative_tol | Define relative tolerance for damped Newton solver. | Real | 1.e-6 | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| newton_solver.max_iterations | Define max number of iterations for damped Newton solver. | Int | 100 | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| thermal_conductivity | Specify which thermal conductivity model to use for solids. | String | constant | +| | Options: | | | +| | | | | +| | * ``constant`` - constant thermal conductivity | | | +| | | | | +| | A thermal conductivity model is not required for solids. | | | +| | Defining a thermal conductivity model enables conductive | | | +| | heat transfer for DEM. However, it has no effect for PIC | | | +| | solids heat transfer. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| thermal_conductivity.constant | Constant solids thermal conductivity value. | Real | 0 | +| | A value is required for ``constant`` thermal conductivity | | | +| | model. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| min_conduction_dist | The surface roughness separating two touching particles. | Real | 2.e-8 | +| | This value is used to remove the singularity that the | | | +| | particle-fluid-particle conduction model develops at | | | +| | the contact interface. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ +| flpc | The fluid lens proportionality constant (flpc) is used to | Real | 0.4 | +| | calculate the radius of the fluid lens surrounding the | | | +| | particle for particle-fluid-particle conduction. | | | ++------------------------------------------+--------------------------------------------------------------+----------+----------+ Below is an example for specifying the solids solver model options. diff --git a/docs/source_docs/user_guide/inputs/species.rst b/docs/source_docs/user_guide/inputs/species.rst index 17037ad6adeca577f31ae4a856266e7c8fbca366..ebd5c724efd3bc163603ff83266a76748869450c 100644 --- a/docs/source_docs/user_guide/inputs/species.rst +++ b/docs/source_docs/user_guide/inputs/species.rst @@ -1,149 +1,164 @@ .. _InputsSpeciesDefs: + +Species solver +============== + +Enabling the species solver +--------------------------- + +The following input is defined using the prefix ``mfix``: + ++-------------------------+------------------------------------------------------------------------+----------+-----------+ +| | Description | Type | Default | ++=========================+========================================================================+==========+===========+ +| solve_species | Enable the MFIX species solver. | Int | 0 | ++-------------------------+------------------------------------------------------------------------+----------+-----------+ + Species definitions -=================== +------------------- The following inputs are defined using the prefix ``species``: -+--------------------------+------------------------------------------------------------------------+----------+-----------+ -| | Description | Type | Default | -+==========================+========================================================================+==========+===========+ -| solve | Specified name(s) of the species or None to disable the | Strings | None | -| | species solver. The name assigned to the species | | | -| | solver is used to specify species inputs. | | | -+--------------------------+------------------------------------------------------------------------+----------+-----------+ -| diffusivity | Fluid species diffusivity model. | String | None | -| | | | | -| | Options: | | | -| | | | | -| | * ``constant`` - a constant diffusion coefficient is used for | | | -| | all fluid species. | | | -| | | | | -+--------------------------+------------------------------------------------------------------------+----------+-----------+ -| diffusivity.constant | Constant species diffusivity - required for | Real | 0 | -| | ``constant`` diffusivity model | | | -| | | | | -+--------------------------+------------------------------------------------------------------------+----------+-----------+ -| specific_heat | Species specific heat model. This setting only applies if either | String | | -| | ``fluid.specific_heat = mixture`` or | | | -| | ``solids.specific_heat = mixture`` | | | -| | | | | -| | Options (case-insensitive): | | | -| | | | | -| | * ``constant`` - a constant specific heat is defined for each species | | | -| | and a *mixture* specific heat is computed based on the fluid or | | | -| | particle composition. | | | -| | | | | -| | * ``NASA7-poly`` - the specific heat of each species is defined by one | | | -| | or more polynomials that are a function of temperature, then the | | | -| | *mixture* specific heat is computed based on the fluid or particle | | | -| | composition. | | | -| | | | | -| | NASA7 polynomial format: | | | -| | | | | -| | :math:`c_p(T)/R = \sum_{i=0}^4 a_{i}T^{i}` | | | -| | | | | -+--------------------------+------------------------------------------------------------------------+----------+-----------+ -| ignore_discontinuities | MFIX-Exa asserts that the low and high NASA-7 polynomials are | Int | 0 | -| | continuous at the 1000K temperature split. However, some polynomials | | | -| | do not have valid high temperature coefficients, for example, liquid | | | -| | water. By setting this keyword to 1, the simulation will only warn | | | -| | that the polynomials are discontinuous. Simulations that use | | | -| | discontinuous polynomials and cross between the 1000K temperature | | | -| | split may fail when computing temperature from enthalpy. | | | -| | Therefore, this option should only be used when the simulation is not | | | -| | expected to cross over the transition temperature. | | | -+--------------------------+------------------------------------------------------------------------+----------+-----------+ -| viscosity.molecular | Molecular viscosity model of species. This setting only applies when | String | | -| | ``fluid.viscosity.molecular = mixture``. | | | -| | | | | -| | Options: | | | -| | | | | -| | * ``constant`` - constant viscosity | | | -| | * ``Sutherland`` :cite:p:`suth1893` | | | -| | * ``Reid`` :cite:p:`reid87` | | | -| | | | | -| | See :ref:`viscosity model descriptions ` | | | -| | in fluid section. | | | -+--------------------------+------------------------------------------------------------------------+----------+-----------+ ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| | Description | Type | Default | ++======================================+=========================================================================+==========+===========+ +| solve | Specified name(s) of the species or None to disable the | Strings | None | +| | species solver. The name assigned to the species | | | +| | solver is used to specify species inputs. | | | ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| diffusivity | Fluid species diffusivity model. | String | None | +| | | | | +| | Options: | | | +| | | | | +| | * ``constant`` - a constant diffusion coefficient is used for | | | +| | all fluid species. | | | +| | | | | ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| diffusivity.constant | Constant species diffusivity - required for | Real | 0 | +| | ``constant`` diffusivity model | | | +| | | | | ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| specific_heat | Species specific heat model. This setting only applies if either | String | | +| | ``fluid.specific_heat = mixture`` or | | | +| | ``solids.specific_heat = mixture`` | | | +| | | | | +| | Options (case-insensitive): | | | +| | | | | +| | * ``constant`` - a constant specific heat is defined for each species | | | +| | and a *mixture* specific heat is computed based on the fluid or | | | +| | particle composition. | | | +| | | | | +| | * ``NASA7-poly`` - the specific heat of each species is defined by one | | | +| | or more polynomials that are a function of temperature, then the | | | +| | *mixture* specific heat is computed based on the fluid or particle | | | +| | composition. | | | +| | | | | +| | NASA7 polynomial format: | | | +| | | | | +| | :math:`c_p(T)/R = \sum_{i=0}^4 a_{i}T^{i}` | | | +| | | | | ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| specific_heat.ignore_discontinuities | MFIX-Exa checks that NASA-7 polynomials are continuous at the specified | Int | 0 | +| | transition temperature(s)(``Tsplit``). However, some polynomials do not | | | +| | have valid high temperature coefficients, for example, liquid water. By | | | +| | setting this keyword to 1, the simulation will only warn that the | | | +| | polynomials are discontinuous. Simulations that use discontinuous | | | +| | polynomials and cross ``Tsplit`` boundaries may fail when computing | | | +| | temperature from enthalpy. Therefore, this option should only be used | | | +| | when the simulation is not expected to cross over the transition | | | +| | temperature. | | | ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| viscosity.molecular | Molecular viscosity model of species. This setting only applies when | String | None | +| | ``[fluid_name].viscosity.molecular`` = ``mixture``. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``None`` - no viscosity model | | | +| | * ``constant`` - constant viscosity | | | +| | * ``Sutherland`` :cite:p:`suth1893` | | | +| | * ``Reid`` :cite:p:`reid87` | | | +| | | | | +| | See :ref:`viscosity model descriptions ` | | | +| | in fluid section. | | | ++--------------------------------------+-------------------------------------------------------------------------+----------+-----------+ The following inputs are defined for each species using the prefix ``species.[species_name]``: -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| | Description | Type | Default | -+=======================================+========================================================================+==========+===========+ -| molecular_weight | Molecular weight of species. Required for mixture molecular weight | Real | 0 | -| | model and when including chemical reactions. | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| specific_heat.constant | Constant species specific heat. Required for all fluid (solids) | Real | 0 | -| | species if the fluid (solids) ``specific_heat = mixture`` and the | | | -| | specific heat model is ``constant`` | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| specific_heat.NASA7.a[i] | Species specific heat polynomial coefficients. Required for all fluid | Real | None | -| | (solids) species if the fluid (solids) ``specific_heat = mixture`` | | | -| | and the specific heat model is ``NASA7-poly`` | | | -| | | | | -| | * Each polynomial is defined by six coefficients (``a0`` ... ``a5``). | | | -| | Coefficients ``a0`` through ``a4`` are use for computing specific | | | -| | heat while all six coefficients are used to compute enthalpy. | | | -| | The seventh coefficient, ``a6``, may be provided for completeness | | | -| | but is not used as MFIX-Exa presently does not need to compute | | | -| | entropy. | | | -| | | | | -| | * By default, two sets of coefficients are required. The coefficients | | | -| | define two polynomials used to compute the specific heat and | | | -| | enthalpy across low and high temperatures. The split temperature | | | -| | (Tsplit) defines the transition from low-to-high polynomials. | | | -| | | | | -| | * A single polynomial can be used for all temperatures by setting the | | | -| | split temperature to -1. | | | -| | | | | -| | * Three or more polynomials can be used by defining multiple split | | | -| | temperatures. | | | -| | | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| specific_heat.NASA7.Tsplit | Defines the temperature transition between NASA-7 polynomials. | Real | 1000. | -| | | | | -| | * Setting ``Tsplit = -1`` signifies that a single polynomial defines | | | -| | the specific heat and enthalpy for all temperatures. | | | -| | | | | -| | * Specifying ``N`` split temperatures where ``N>1``, signifies ``N+1`` | | | -| | polynomials are used to define the specific heat and enthalpy. | | | -| | | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| enthalpy_of_formation | Enthalpy of formation of species. Required only when | Real | 0 | -| | the specific heat model is ``constant`` and chemical reactions | | | -| | are defined. | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| viscosity.molecular.constant | Constant species fluid viscosity. | Real | 0 | -| | | | | -| | A value is required for ``constant`` species viscosity model. | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| viscosity.molecular.Sutherland.T_ref | Sutherland model reference temperature for species. | Real | 0 | -| | | | | -| | A value is required for ``Sutherland`` species viscosity model. | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| viscosity.molecular.Sutherland.mu_ref | Sutherland model reference viscosity at T_ref for species. | Real | 0 | -| | | | | -| | A value is required for ``Sutherland`` species viscosity model. | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| viscosity.molecular.Sutherland.S | Sutherland model temperature for species. | Real | 0 | -| | | | | -| | A value is required for ``Sutherland`` species viscosity model. | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| viscosity.molecular.Reid.A | Reid model constants for species. | Real | 0 | -| viscosity.molecular.Reid.B | | | | -| viscosity.molecular.Reid.C | Values are required for ``Reid`` species viscosity model. | | | -| viscosity.molecular.Reid.D | | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ -| density | Constant species density (only used for solid phase species). | Real | 0. | -| | | | | -| | Needed for all solid species if | | | -| | :ref:`solids density` is set to ``mixture`` or | | | -| | :ref:`density updates` is set to | | | -| | ``Constant_Species_Densities`` | | | -+---------------------------------------+------------------------------------------------------------------------+----------+-----------+ ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| | Description | Type | Default | ++=======================================+=========================================================================+==========+===========+ +| molecular_weight | Molecular weight of species. Required for mixture molecular weight | Real | 0 | +| | model and when including chemical reactions. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| specific_heat.constant | Constant species specific heat. Required for all fluid (solids) | Real | 0 | +| | species if the fluid (solids) ``specific_heat = mixture`` and the | | | +| | specific heat model is ``constant`` | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| specific_heat.NASA7.a[i] | Species specific heat polynomial coefficients. Required for all fluid | Reals | None | +| | (solids) species if the fluid (solids) ``specific_heat = mixture`` | | | +| | and the specific heat model is ``NASA7-poly`` | | | +| | | | | +| | * Each polynomial is defined by six coefficients (``a0`` ... ``a5``). | | | +| | Coefficients ``a0`` through ``a4`` are use for computing specific | | | +| | heat while all six coefficients are used to compute enthalpy. | | | +| | The seventh coefficient, ``a6``, may be provided for completeness | | | +| | but is not used as MFIX-Exa presently does not need to compute | | | +| | entropy. | | | +| | | | | +| | * By default, two sets of coefficients are required. The coefficients | | | +| | define two polynomials used to compute the specific heat and | | | +| | enthalpy across low and high temperatures. The transition temperature | | | +| | (``Tsplit``) defines the transition from low to high polynomials. | | | +| | | | | +| | * A single polynomial can be used for all temperatures by setting the | | | +| | transition temperature to -1. | | | +| | | | | +| | * Three or more polynomials can be used by defining multiple transition | | | +| | temperatures. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| specific_heat.NASA7.Tsplit | Defines the transition temperature between NASA-7 polynomials. | Reals | 1000 | +| | | | | +| | * Setting ``Tsplit = -1`` signifies that a single polynomial defines | | | +| | the specific heat and enthalpy for all temperatures. | | | +| | | | | +| | * Specifying ``N`` temperatures signifies that ``N+1`` polynomials are | | | +| | used to define the specific heat and enthalpy. | | | +| | | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| enthalpy_of_formation | Enthalpy of formation of species. Required only when | Real | 0 | +| | the specific heat model is ``constant`` and chemical reactions | | | +| | are defined. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| viscosity.molecular.constant | Constant species fluid viscosity. | Real | 0 | +| | | | | +| | A value is required for ``constant`` species viscosity model. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| viscosity.molecular.Sutherland.T_ref | Sutherland model reference temperature for species. | Real | 0 | +| | | | | +| | A value is required for ``Sutherland`` species viscosity model. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| viscosity.molecular.Sutherland.mu_ref | Sutherland model reference viscosity at T_ref for species. | Real | 0 | +| | | | | +| | A value is required for ``Sutherland`` species viscosity model. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| viscosity.molecular.Sutherland.S | Sutherland model temperature for species. | Real | 0 | +| | | | | +| | A value is required for ``Sutherland`` species viscosity model. | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| viscosity.molecular.Reid.A | Reid model constants for species. | Real | 0 | +| viscosity.molecular.Reid.B | | | | +| viscosity.molecular.Reid.C | Values are required for ``Reid`` species viscosity model. | | | +| viscosity.molecular.Reid.D | | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ +| density | Constant species density (only used for solid phase species). | Real | 0. | +| | | | | +| | Needed for all solid species if | | | +| | :ref:`solids density` is set to ``mixture`` or | | | +| | :ref:`density updates` is set to | | | +| | ``Constant_Species_Densities`` | | | ++---------------------------------------+-------------------------------------------------------------------------+----------+-----------+ Example inputs diff --git a/duplicate-keys.txt b/duplicate-keys.txt index efa155e121adf2997a2b34813017ba7b2a6ec497..dd14b439648d77dbb688d32a693bc1947d3786f4 100644 --- a/duplicate-keys.txt +++ b/duplicate-keys.txt @@ -1,11 +1,4 @@ Duplicate keys: -ascent.actions: ascent.rst, plotting.rst -bc.[region_name].[fluid_name].massflow: boundary_conditions.rst, boundary_conditions.rst -bc.[region_name].[fluid_name].velocity: boundary_conditions.rst, boundary_conditions.rst -bc.[region_name].[fluid_name].volflow: boundary_conditions.rst, boundary_conditions.rst -bc.[region_name].[fluid_name].volfrac: boundary_conditions.rst, boundary_conditions.rst hypre.bamg_num_down_sweeps: multigrid_solvers.rst, multigrid_solvers.rst hypre.bamg_num_sweeps: multigrid_solvers.rst, multigrid_solvers.rst -mfix.ascent_int: ascent.rst, plotting.rst -mfix.ascent_per_approx: ascent.rst, plotting.rst mfix.restart: checkpointing.rst, initialization.rst diff --git a/nonexistent-keys.txt b/nonexistent-keys.txt index 72a209ed25de7fab303e675840ac780b37f58832..de176ccbc687df26639bfd02c3f77e1931b2961c 100644 --- a/nonexistent-keys.txt +++ b/nonexistent-keys.txt @@ -1,4 +1,3 @@ -# This group may be incorrect bc.[region_name].[solid_name].bins bc.[region_name].[solid_name].density.custom bc.[region_name].[solid_name].density.max