diff --git a/docs/source_docs/refs.bib b/docs/source_docs/refs.bib index a250d504a04776a6c3f85b38aa3760fdb1b0fdf2..57e965dae16f6a98ac840ef4288e33c8631c2ecd 100644 --- a/docs/source_docs/refs.bib +++ b/docs/source_docs/refs.bib @@ -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}, @@ -454,16 +463,16 @@ doi = {https://doi.org/10.1016/j.jcp.2022.111305}, pages = {318-320} } -@article { Smag63, - author = "J. Smagorinsky", - title = "General circulation experiments with the primitive equations: I. The basic experiment", - journal = "Monthly Weather Review", - year = "1963", - publisher = "American Meteorological Society", - address = "Boston MA, USA", - volume = "91", - number = "3", - pages= "99 - 164" +@article{Smag63, + author = "J. Smagorinsky", + title = "General circulation experiments with the primitive equations: I. The basic experiment", + journal = "Monthly Weather Review", + year = "1963", + publisher = "American Meteorological Society", + address = "Boston MA, USA", + volume = "91", + number = "3", + pages= "99 - 164" } @@ -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}, diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index a55b4a22c26742702d5d34ec303a2069081e2257..e2dd23f6e8dbb072a1d702cbd49c9aa3e75be409 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -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`` | +| | the fluid solver. The name assigned to the fluid solver is | | | +| | 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 | +============================================+============================================================+========+==========+ -| 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. | | | -+--------------------------------------------+------------------------------------------------------------+--------+----------+ | 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.eddy | Specify eddy viscosty model. | String | None | +| 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 viscosity model. | String | None | | | | | | | | Available options include: | | | | | | | | @@ -40,25 +73,31 @@ 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 | -| | :math:`\mu_{susp}=\mu_{mol}(\mu^* - 1)` | | | +| 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` | | | +| | | | | +| | :math:`\mu^*=1` | | | | | | | | | | * ``Einstein`` :cite:p:`einstein11` | | | -| | :math:`\mu^*=1 + 2.5\varepsilon_s` | | | +| | | | | +| | :math:`\mu^*=1 + 2.5\varepsilon_s` | | | | | | | | | | * ``Brinkman`` :cite:p:`brinkman52,gibilaro07` | | | -| | :math:`\mu^*=(1-\varepsilon_s)^{-c}` | | | +| | | | | +| | :math:`\mu^*=(1-\varepsilon_s)^{-c}` | | | | | | | | | | * ``Roscoe`` :cite:p:`roscoe52,krieger59,maron56` | | | -| | :math:`\mu^*=(1-\varepsilon_s/c_1)^{-c_2}` | | | +| | | | | +| | :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}` | | | +| | | | | +| | :math:`\mu^*=e^{2.5(1/(1-\varepsilon_s)^c-1)/c}` | | | | | | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | viscosity.suspension.Brinkman.constant | Constant for exponent in Brinkman suspension expression. | Real | None | @@ -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: | | | | | | | | @@ -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 @@ -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 @@ -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