Loading docs/source_docs/refs.bib +7 −0 Original line number Diff line number Diff line Loading @@ -93,6 +93,13 @@ pages = {379-402} url = {https://www.sciencedirect.com/science/article/pii/S0021999120305945}, } @book{bird06, author = {Bird, R B and Stewart, W E and Lightfoot, E N}, title = {Transport Phenomena 2nd Edition}, year = {2006}, publisher={Wiley} } @article{blais2019, title={Experimental methods in chemical engineering: Discrete element method--DEM}, author={Blais, Bruno and Vidal, David and Bertrand, Francois and Patience, Gregory S and Chaouki, Jamal}, Loading docs/source_docs/user_guide/inputs/fluid_model.rst +11 −1 Original line number Diff line number Diff line .. _InputsFluidModel: Fluid model =========== Loading @@ -19,12 +21,14 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill .. |Sutherland_Eq| replace:: :math:`\mu(T) = \mu_{ref}\left(\frac{T}{T_{ref}}\right)^{3/2}\frac{T_{ref} + S}{T+S}` .. |Reid_4parm_Eq| replace:: :math:`\mu(T) = A\exp{\left( \frac{B}{T} + CT + DT^2 \right)}` .. |Reid_4parm_Eq| replace:: :math:`\mu(T) = Ae^{\left(\frac{B}{T} + CT + DT^2 \right)}` .. |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 | +============================================+============================================================+========+==========+ Loading @@ -41,6 +45,12 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | | | | | | |Reid_4parm_Eq| | | | | | | | | | | * ``mixture`` a mixture viscosity is computed from | | | | | :ref:`species viscosities<InputsSpeciesDefs>` | | | | | and local species mass fractions :cite:p:`bird06` | | | | | | | | | | |mix_Eq| | | | | | | | | | | A viscosity model is required if the fluid solver is | | | | | enabled. | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ Loading docs/source_docs/user_guide/inputs/species_defs.rst +33 −6 Original line number Diff line number Diff line Loading @@ -52,20 +52,26 @@ The following inputs are defined using the ``species`` prefix. | | 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 | 0 | | | ``fluid.viscosity.molecular = mixture``. | | | | | | | | | | Options are ``constant`` or ``Sutherland`` or ``Reid``. | | | | | See :ref:`viscosity model descriptions <InputsFluidModel>`. | | | +--------------------------+------------------------------------------------------------------------+----------+-----------+ The following inputs are for each species defined using the ``species.[species name]`` prefix. +--------------------------+------------------------------------------------------------------------+----------+-----------+ +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ | | 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 | 0. 0. | | | (solids) species if the fluid (solids) ``specific_heat = mixture`` | | | | | and the specific heat model is ``NASA7-poly`` | | | Loading @@ -76,11 +82,32 @@ The following inputs are for each species defined using the ``species.[species n | | the coefficient for the high temperature polynomial (T > 1000K). A | | | | | total of twelve coefficients are required. | | | | | | | | +--------------------------+------------------------------------------------------------------------+----------+-----------+ +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ | enthalpy_of_formation | Enthalpy of formation of species. This input is 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, and | Values are required for ``Reid`` species viscosity model. | | | | viscosity.molecular.Reid.D | | | | +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ Loading Loading
docs/source_docs/refs.bib +7 −0 Original line number Diff line number Diff line Loading @@ -93,6 +93,13 @@ pages = {379-402} url = {https://www.sciencedirect.com/science/article/pii/S0021999120305945}, } @book{bird06, author = {Bird, R B and Stewart, W E and Lightfoot, E N}, title = {Transport Phenomena 2nd Edition}, year = {2006}, publisher={Wiley} } @article{blais2019, title={Experimental methods in chemical engineering: Discrete element method--DEM}, author={Blais, Bruno and Vidal, David and Bertrand, Francois and Patience, Gregory S and Chaouki, Jamal}, Loading
docs/source_docs/user_guide/inputs/fluid_model.rst +11 −1 Original line number Diff line number Diff line .. _InputsFluidModel: Fluid model =========== Loading @@ -19,12 +21,14 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill .. |Sutherland_Eq| replace:: :math:`\mu(T) = \mu_{ref}\left(\frac{T}{T_{ref}}\right)^{3/2}\frac{T_{ref} + S}{T+S}` .. |Reid_4parm_Eq| replace:: :math:`\mu(T) = A\exp{\left( \frac{B}{T} + CT + DT^2 \right)}` .. |Reid_4parm_Eq| replace:: :math:`\mu(T) = Ae^{\left(\frac{B}{T} + CT + DT^2 \right)}` .. |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 | +============================================+============================================================+========+==========+ Loading @@ -41,6 +45,12 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | | | | | | | |Reid_4parm_Eq| | | | | | | | | | | * ``mixture`` a mixture viscosity is computed from | | | | | :ref:`species viscosities<InputsSpeciesDefs>` | | | | | and local species mass fractions :cite:p:`bird06` | | | | | | | | | | |mix_Eq| | | | | | | | | | | A viscosity model is required if the fluid solver is | | | | | enabled. | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ Loading
docs/source_docs/user_guide/inputs/species_defs.rst +33 −6 Original line number Diff line number Diff line Loading @@ -52,20 +52,26 @@ The following inputs are defined using the ``species`` prefix. | | 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 | 0 | | | ``fluid.viscosity.molecular = mixture``. | | | | | | | | | | Options are ``constant`` or ``Sutherland`` or ``Reid``. | | | | | See :ref:`viscosity model descriptions <InputsFluidModel>`. | | | +--------------------------+------------------------------------------------------------------------+----------+-----------+ The following inputs are for each species defined using the ``species.[species name]`` prefix. +--------------------------+------------------------------------------------------------------------+----------+-----------+ +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ | | 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 | 0. 0. | | | (solids) species if the fluid (solids) ``specific_heat = mixture`` | | | | | and the specific heat model is ``NASA7-poly`` | | | Loading @@ -76,11 +82,32 @@ The following inputs are for each species defined using the ``species.[species n | | the coefficient for the high temperature polynomial (T > 1000K). A | | | | | total of twelve coefficients are required. | | | | | | | | +--------------------------+------------------------------------------------------------------------+----------+-----------+ +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ | enthalpy_of_formation | Enthalpy of formation of species. This input is 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, and | Values are required for ``Reid`` species viscosity model. | | | | viscosity.molecular.Reid.D | | | | +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ Loading
