Loading docs/source_docs/refs.bib +22 −0 Original line number Diff line number Diff line Loading @@ -428,6 +428,15 @@ doi = {https://doi.org/10.1016/j.jcp.2022.111305}, } @book{reid87, author = {Reid, R C and Prausnitz, J M and Poling, B E}, title = {The properties of gases and liquids}, url = {https://www.osti.gov/biblio/6504847}, year = {1987}, publisher={McGraw-Hill} } @article{Ric54, author = {Richardson, J. F. and Zaki, W. N.}, title = {Sedimentation and Fluidization: Part I}, Loading Loading @@ -478,6 +487,19 @@ doi = {https://doi.org/10.1016/j.jcp.2022.111305}, publisher={Elsevier} } @article{suth1893, author = {William Sutherland}, title = {LII. The viscosity of gases and molecular force }, journal = {The London, Edinburgh, and Dublin Philosophical Magazine and Journal of Science}, volume = {36}, number = {223}, pages = {507--531}, year = {1893}, publisher = {Taylor \& Francis}, } @article{tang15, author = {Tang, Y. and Peters, E. A. J. F. and Kuipers, J. A. M. and Kriebitzsch, S. H. L. and van der Hoef, M. A.}, title = {A New Drag Correlation from Fully Resolved Simulations of Flow Past Monodisperse Static Arrays of Spheres}, Loading docs/source_docs/user_guide/inputs/fluid_model.rst +64 −25 Original line number Diff line number Diff line Loading @@ -3,27 +3,60 @@ Fluid model The following inputs are defined using the ``fluid`` prefix. +--------------------------------------------+------------------------------------------------------------+--------+----------+ +--------------------------------------------+-------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +============================================+============================================================+========+==========+ | solve | Specify the name of the fluid or set to None to disable | String | None | +============================================+=============================================================+========+==========+ | solve | Specify the name of the fluid or set to ``None`` to disable | String | ``None`` | | | the fluid solver. The name assigned to the fluid solver is | | | | | used to specify fluid initial and boundary conditions. | | | | | used to specify fluid properties and initial and boundary | | | | | conditions. | | | +--------------------------------------------+-------------------------------------------------------------+--------+----------+ The root prefix for the following inputs use the name defined using the ``fluid.solve`` keyword. For example, if the fluid solver is named ``myfluid``, then the following keywords are preceded with ``myfluid`` and a period. Currently, MFIX-Exa only supports a single fluid; therefore, it is common to name the fluid ``fluid``. This is illustrated later in example input snippets. .. |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)}` +--------------------------------------------+------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +============================================+============================================================+========+==========+ | viscosity.molecular | Specify which molecular viscosity model to use. | String | None | | | | | | | | Available options include: | | | | | | | | | | * ``constant`` for constant viscosity model | | | | | * ``constant`` constant viscosity | | | | | * ``Sutherland`` :cite:p:`suth1893` | | | | | | | | | | |Sutherland_Eq| | | | | | | | | | | * ``Reid`` :cite:p:`reid87` | | | | | | | | | | |Reid_4parm_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.eddy | Specify eddy viscosty model. | String | None | | viscosity.eddy | Specify eddy viscosity model. | String | None | | | | | | | | Available options include: | | | | | | | | Loading @@ -40,24 +73,30 @@ The following inputs are defined using the ``fluid`` prefix. +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.eddy.WALE.constant | WALE eddy viscosity model constant. | Real | 0.325 | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.suspension | Specify suspension viscosty model of the form | String | None | | viscosity.suspension | Specify suspension viscosity model of the form | String | None | | | | | | | | :math:`\mu_{susp}=\mu_{mol}(\mu^* - 1)` | | | | | | | | | | Available options include: | | | | | | | | | | * ``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}` | | | | | | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ Loading Loading @@ -96,7 +135,7 @@ The following inputs are defined using the ``fluid`` prefix. | | | | | | | * ``NASA7-poly`` the fluid specific heat is defined by a | | | | | low-temperature (T < 1000K) polynomial and a | | | | | high-temprature (T > 1000K) polynomial. | | | | | high-temperature (T > 1000K) polynomial. | | | | | | | | | | NASA7 polynomial format: | | | | | | | | Loading Loading @@ -181,8 +220,8 @@ are not solved. # ----------------------------------------------------------------------- fluid.solve = fluid0 fluid.viscosity.molecular = constant fluid.viscosity.molecular.constant = 1.8e-5 fluid0.viscosity.molecular = constant fluid0.viscosity.molecular.constant = 1.8e-5 # Initial Conditions Loading Loading @@ -235,10 +274,10 @@ pressure when evaluating the equation of state. # ----------------------------------------------------------------------- fluid.solve = fluid0 fluid.viscosity.molecular = constant fluid.viscosity.molecular.constant = 1.8e-5 fluid0.viscosity.molecular = constant fluid0.viscosity.molecular.constant = 1.8e-5 fluid.molecular_weight = 29.0e-3 fluid0.molecular_weight = 29.0e-3 # Initial Conditions Loading Loading @@ -293,22 +332,22 @@ thermodynamic pressure for the system. # ----------------------------------------------------------------------- fluid.solve = fluid0 fluid.viscosity.molecular = constant fluid.viscosity.molecular.constant = 2.0e-5 fluid0.viscosity.molecular = constant fluid0.viscosity.molecular.constant = 2.0e-5 fluid.thermal_conductivity = constant fluid.thermal_conductivity.constant = 0.026 fluid0.thermal_conductivity = constant fluid0.thermal_conductivity.constant = 0.026 fluid.molecular_weight = 28.96518e-3 fluid0.molecular_weight = 28.96518e-3 fluid.specific_heat = NASA7-poly fluid0.specific_heat = NASA7-poly fluid.specific_heat.NASA7.a0 = 5.95960930E+00 3.08792717E+00 fluid.specific_heat.NASA7.a1 = 3.56839620E+00 1.24597184E-03 fluid.specific_heat.NASA7.a2 = -6.78729429E-04 -4.23718945E-07 fluid.specific_heat.NASA7.a3 = 1.55371476E-06 6.74774789E-11 fluid.specific_heat.NASA7.a4 = -3.29937060E-12 -3.97076972E-15 fluid.specific_heat.NASA7.a5 = -4.66395387E-13 -9.95262755E+02 fluid0.specific_heat.NASA7.a0 = 5.95960930E+00 3.08792717E+00 fluid0.specific_heat.NASA7.a1 = 3.56839620E+00 1.24597184E-03 fluid0.specific_heat.NASA7.a2 = -6.78729429E-04 -4.23718945E-07 fluid0.specific_heat.NASA7.a3 = 1.55371476E-06 6.74774789E-11 fluid0.specific_heat.NASA7.a4 = -3.29937060E-12 -3.97076972E-15 fluid0.specific_heat.NASA7.a5 = -4.66395387E-13 -9.95262755E+02 # Initial Conditions Loading Loading
docs/source_docs/refs.bib +22 −0 Original line number Diff line number Diff line Loading @@ -428,6 +428,15 @@ doi = {https://doi.org/10.1016/j.jcp.2022.111305}, } @book{reid87, author = {Reid, R C and Prausnitz, J M and Poling, B E}, title = {The properties of gases and liquids}, url = {https://www.osti.gov/biblio/6504847}, year = {1987}, publisher={McGraw-Hill} } @article{Ric54, author = {Richardson, J. F. and Zaki, W. N.}, title = {Sedimentation and Fluidization: Part I}, Loading Loading @@ -478,6 +487,19 @@ doi = {https://doi.org/10.1016/j.jcp.2022.111305}, publisher={Elsevier} } @article{suth1893, author = {William Sutherland}, title = {LII. The viscosity of gases and molecular force }, journal = {The London, Edinburgh, and Dublin Philosophical Magazine and Journal of Science}, volume = {36}, number = {223}, pages = {507--531}, year = {1893}, publisher = {Taylor \& Francis}, } @article{tang15, author = {Tang, Y. and Peters, E. A. J. F. and Kuipers, J. A. M. and Kriebitzsch, S. H. L. and van der Hoef, M. A.}, title = {A New Drag Correlation from Fully Resolved Simulations of Flow Past Monodisperse Static Arrays of Spheres}, Loading
docs/source_docs/user_guide/inputs/fluid_model.rst +64 −25 Original line number Diff line number Diff line Loading @@ -3,27 +3,60 @@ Fluid model The following inputs are defined using the ``fluid`` prefix. +--------------------------------------------+------------------------------------------------------------+--------+----------+ +--------------------------------------------+-------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +============================================+============================================================+========+==========+ | solve | Specify the name of the fluid or set to None to disable | String | None | +============================================+=============================================================+========+==========+ | solve | Specify the name of the fluid or set to ``None`` to disable | String | ``None`` | | | the fluid solver. The name assigned to the fluid solver is | | | | | used to specify fluid initial and boundary conditions. | | | | | used to specify fluid properties and initial and boundary | | | | | conditions. | | | +--------------------------------------------+-------------------------------------------------------------+--------+----------+ The root prefix for the following inputs use the name defined using the ``fluid.solve`` keyword. For example, if the fluid solver is named ``myfluid``, then the following keywords are preceded with ``myfluid`` and a period. Currently, MFIX-Exa only supports a single fluid; therefore, it is common to name the fluid ``fluid``. This is illustrated later in example input snippets. .. |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)}` +--------------------------------------------+------------------------------------------------------------+--------+----------+ | | Description | Type | Default | +============================================+============================================================+========+==========+ | viscosity.molecular | Specify which molecular viscosity model to use. | String | None | | | | | | | | Available options include: | | | | | | | | | | * ``constant`` for constant viscosity model | | | | | * ``constant`` constant viscosity | | | | | * ``Sutherland`` :cite:p:`suth1893` | | | | | | | | | | |Sutherland_Eq| | | | | | | | | | | * ``Reid`` :cite:p:`reid87` | | | | | | | | | | |Reid_4parm_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.eddy | Specify eddy viscosty model. | String | None | | viscosity.eddy | Specify eddy viscosity model. | String | None | | | | | | | | Available options include: | | | | | | | | Loading @@ -40,24 +73,30 @@ The following inputs are defined using the ``fluid`` prefix. +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.eddy.WALE.constant | WALE eddy viscosity model constant. | Real | 0.325 | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.suspension | Specify suspension viscosty model of the form | String | None | | viscosity.suspension | Specify suspension viscosity model of the form | String | None | | | | | | | | :math:`\mu_{susp}=\mu_{mol}(\mu^* - 1)` | | | | | | | | | | Available options include: | | | | | | | | | | * ``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}` | | | | | | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ Loading Loading @@ -96,7 +135,7 @@ The following inputs are defined using the ``fluid`` prefix. | | | | | | | * ``NASA7-poly`` the fluid specific heat is defined by a | | | | | low-temperature (T < 1000K) polynomial and a | | | | | high-temprature (T > 1000K) polynomial. | | | | | high-temperature (T > 1000K) polynomial. | | | | | | | | | | NASA7 polynomial format: | | | | | | | | Loading Loading @@ -181,8 +220,8 @@ are not solved. # ----------------------------------------------------------------------- fluid.solve = fluid0 fluid.viscosity.molecular = constant fluid.viscosity.molecular.constant = 1.8e-5 fluid0.viscosity.molecular = constant fluid0.viscosity.molecular.constant = 1.8e-5 # Initial Conditions Loading Loading @@ -235,10 +274,10 @@ pressure when evaluating the equation of state. # ----------------------------------------------------------------------- fluid.solve = fluid0 fluid.viscosity.molecular = constant fluid.viscosity.molecular.constant = 1.8e-5 fluid0.viscosity.molecular = constant fluid0.viscosity.molecular.constant = 1.8e-5 fluid.molecular_weight = 29.0e-3 fluid0.molecular_weight = 29.0e-3 # Initial Conditions Loading Loading @@ -293,22 +332,22 @@ thermodynamic pressure for the system. # ----------------------------------------------------------------------- fluid.solve = fluid0 fluid.viscosity.molecular = constant fluid.viscosity.molecular.constant = 2.0e-5 fluid0.viscosity.molecular = constant fluid0.viscosity.molecular.constant = 2.0e-5 fluid.thermal_conductivity = constant fluid.thermal_conductivity.constant = 0.026 fluid0.thermal_conductivity = constant fluid0.thermal_conductivity.constant = 0.026 fluid.molecular_weight = 28.96518e-3 fluid0.molecular_weight = 28.96518e-3 fluid.specific_heat = NASA7-poly fluid0.specific_heat = NASA7-poly fluid.specific_heat.NASA7.a0 = 5.95960930E+00 3.08792717E+00 fluid.specific_heat.NASA7.a1 = 3.56839620E+00 1.24597184E-03 fluid.specific_heat.NASA7.a2 = -6.78729429E-04 -4.23718945E-07 fluid.specific_heat.NASA7.a3 = 1.55371476E-06 6.74774789E-11 fluid.specific_heat.NASA7.a4 = -3.29937060E-12 -3.97076972E-15 fluid.specific_heat.NASA7.a5 = -4.66395387E-13 -9.95262755E+02 fluid0.specific_heat.NASA7.a0 = 5.95960930E+00 3.08792717E+00 fluid0.specific_heat.NASA7.a1 = 3.56839620E+00 1.24597184E-03 fluid0.specific_heat.NASA7.a2 = -6.78729429E-04 -4.23718945E-07 fluid0.specific_heat.NASA7.a3 = 1.55371476E-06 6.74774789E-11 fluid0.specific_heat.NASA7.a4 = -3.29937060E-12 -3.97076972E-15 fluid0.specific_heat.NASA7.a5 = -4.66395387E-13 -9.95262755E+02 # Initial Conditions Loading
