update docs (!157) · Merge requests · exa / docs

docs/source_docs/user_guide/inputs/fluid_model.rst

+51 −34

Changes for docs/source_docs/user_guide/inputs/fluid_model.rst: 51 added lines, 34 removed lines.
Original line number	Diff line number	Diff line
		@@ -27,12 +27,11 @@ 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: \| \| \|
		@@ -55,28 +54,28 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill
		\| \| \| \| \|
		\| \| 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: \| \| \|
		@@ -85,15 +84,15 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill
		\| \| * ``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)` \| \| \|
		@@ -128,48 +127,53 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill
		\| \| \| \| \|
		\| \| :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<InputsSpeciesDefs>` \| \| \|
		\| \| 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 \| \| \|
		@@ -190,23 +194,36 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill
		\| \| \| \| \|
		\| \| :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 \|
		+--------------------------------------------+----------------------------------------------------------------+--------+----------+
		\| 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<InputsSpeciesDefs>`. \| \| \|
		\| \| \| \| \|
		+--------------------------------------------+----------------------------------------------------------------+--------+----------+
		\| 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<InputsSpeciesDefs>`. \| \| \|
		\| \| \| \| \|
		+--------------------------------------------+------------------------------------------------------------+--------+----------+
		+--------------------------------------------+----------------------------------------------------------------+--------+----------+
		\| 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: \| \| \|
		\| \| \| \| \|
		@@ -215,22 +232,22 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill
		\| \| \| \| \|
		\| \| 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

docs/source_docs/user_guide/inputs/initial_conditions.rst

+1 −1

Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -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 \|
		+-----------------------+------------------------------------------------------------------------+-------------+-----------+

docs/source_docs/user_guide/inputs/model_options.rst

+12 −13

Changes for docs/source_docs/user_guide/inputs/model_options.rst: 12 added lines, 13 removed lines.
Original line number	Diff line number	Diff line
		@@ -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,25 +308,26 @@ 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` \| \| \|
		\| \| * ``WenYu``- Wen-Yu :cite:p:`Wen66` \| \| \|
		\| \| * ``Gidaspow`` :cite:p:`ding90,Lat00` \| \| \|
		\| \| * ``BVK2`` :cite:p:`Bee07,Bee071,tenneti11,tang15` \| \| \|
		\| \| * ``SyamOBrien`` -- Syamlal-O'Brien :cite:p:`syam88` \| \| \|
		\| \| * ``UserDrag`` \| \| \|
		\| \| * ``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. \| \| \|
		\| \| \| \| \|
		@@ -346,9 +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::

docs/source_docs/user_guide/inputs/solids_model.rst

+60 −17

Changes for docs/source_docs/user_guide/inputs/solids_model.rst: 60 added lines, 17 removed lines.
Original line number	Diff line number	Diff line
		@@ -9,15 +9,15 @@ 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): \| \| \|
		@@ -29,28 +29,71 @@ models. The following inputs are defined with the prefix ``solids``:
		\| \| constant :ref:`species densities<InputsSpeciesDefs>` 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 specific heat \| \| \|
		+------------------------------------------+-------------------------------------------------------------+----------+----------+
		\| \| * ``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<InputsSpeciesDefs>`. \| \| \|
		\| \| \| \| \|
		\| \| * ``mixture`` - a mixture specific heat is computed \| \| \|
		\| \| from :ref:`species specific heats<InputsSpeciesDefs>` \| \| \|
		\| \| 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<InputsSpeciesDefs>`. \| \| \|
		\| \| \| \| \|
		+------------------------------------------+--------------------------------------------------------------+----------+----------+
		\| 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<InputsSpeciesDefs>`. \| \| \|
		+------------------------------------------+--------------------------------------------------------------+----------+----------+
		\| 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: \| \| \|
		\| \| \| \| \|
		@@ -60,20 +103,20 @@ models. The following inputs are defined with the prefix ``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.

docs/source_docs/user_guide/inputs/species.rst

+57 −42

File changed.

Preview size limit exceeded, changes collapsed.

Original line number	Diff line number	Diff line
		@@ -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,25 +308,26 @@ 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` \| \| \|
		\| \| * ``WenYu``- Wen-Yu :cite:p:`Wen66` \| \| \|
		\| \| * ``Gidaspow`` :cite:p:`ding90,Lat00` \| \| \|
		\| \| * ``BVK2`` :cite:p:`Bee07,Bee071,tenneti11,tang15` \| \| \|
		\| \| * ``SyamOBrien`` -- Syamlal-O'Brien :cite:p:`syam88` \| \| \|
		\| \| * ``UserDrag`` \| \| \|
		\| \| * ``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. \| \| \|
		\| \| \| \| \|
		@@ -346,9 +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::

Original line number	Diff line number	Diff line
		@@ -9,15 +9,15 @@ 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): \| \| \|
		@@ -29,28 +29,71 @@ models. The following inputs are defined with the prefix ``solids``:
		\| \| constant :ref:`species densities<InputsSpeciesDefs>` 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 specific heat \| \| \|
		+------------------------------------------+-------------------------------------------------------------+----------+----------+
		\| \| * ``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<InputsSpeciesDefs>`. \| \| \|
		\| \| \| \| \|
		\| \| * ``mixture`` - a mixture specific heat is computed \| \| \|
		\| \| from :ref:`species specific heats<InputsSpeciesDefs>` \| \| \|
		\| \| 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<InputsSpeciesDefs>`. \| \| \|
		\| \| \| \| \|
		+------------------------------------------+--------------------------------------------------------------+----------+----------+
		\| 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<InputsSpeciesDefs>`. \| \| \|
		+------------------------------------------+--------------------------------------------------------------+----------+----------+
		\| 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: \| \| \|
		\| \| \| \| \|
		@@ -60,20 +103,20 @@ models. The following inputs are defined with the prefix ``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.

update docs

Merge request reports