diff --git a/docs/source_docs/refs.bib b/docs/source_docs/refs.bib index 5bec8d1ce75072b2a1912eba348e02a9a6c43292..c0024a0789b5571514fdc286e3694e3e4d6ef9b2 100644 --- a/docs/source_docs/refs.bib +++ b/docs/source_docs/refs.bib @@ -310,6 +310,17 @@ doi = {https://doi.org/10.1016/j.jcp.2022.111305}, pages = {2297-2304} } + +@techreport{Lilly66, + author={Lilly, D.K.}, + title={On the Application of the Eddy Viscosity Concept in the Inertial Sub-range of Turbulence}, + institution = {National Center for Atmospheric Research},, + year = {1966}, + address = {Boulder, United States}, + publisher = {NOAA/NCAR Boulder Atmospheric Observatory}, +} + + @article{Massoudi03, author = {Mehrdad Massoudi}, title = {Constitutive relations for the interaction force in multicomponent particulate flows}, @@ -372,6 +383,19 @@ 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{stevens05, title={Comparison of soft-sphere models to measurements of collision properties during normal impacts}, author={Stevens, AB and Hrenya, CM}, diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 955256ab81a47cf7e37d3b312ad43724fe29d722..9cc01fe7dfea27ee55278969a32f488532b91108 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -3,101 +3,116 @@ 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 initial and boundary conditions. | | | -+------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity | Specify which viscosity model to use for the fluid. | String | None | -| | Available options include: | | | -| | | | | -| | * ``constant`` for constant viscosity model | | | -| | | | | -| | A viscosity model is required if the fluid solver is | | | -| | enabled. | | | -+------------------------------------------+------------------------------------------------------------+--------+----------+ -| viscosity.constant | Constant fluid viscosity. | Real | 0 | -| | A value is required for ``constant`` viscosity model. | | | -| | | | | -+------------------------------------------+------------------------------------------------------------+--------+----------+ -| species | Specify the species that constitute the fluid. | String | 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 *ideal gas* constraints and the species equations | | | -| | are not solved. | | | -+------------------------------------------+------------------------------------------------------------+--------+----------+ -| specific_heat | Specify which specific heat model to use for the fluid. | String | None | -| | Available options include: | | | -| | | | | -| | * ``constant`` - the fluid has a constant specific heat | | | -| | | | | -| | * ``NASA7-poly`` the fluid specific heat is defined by a | | | -| | low-temperature (T < 1000K) polynomial and a | | | -| | high-temprature (T > 1000K) polynomial. | | | -| | | | | -| | NASA7 polynomial format: | | | -| | | | | -| | :math:`c_p(T) = \sum_{i=0}^5 a_iT^i` | | | -| | | | | -| | * ``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 | 0. 0. | -| | coefficients are required if the fluid specific heat | | | -| | model is ``NASA7-poly``. | | | -| | | | | -| | Each polynomial is defined by six coefficients (``a0``, | | | -| | ..., ``a5``), and two values are required for each | | | -| | coefficient. The first value is the low temperature | | | -| | polynomial coefficient (T < 1000K) and the second is the | | | -| | coefficient for the high temperature polynomial | | | -| | (T > 1000K). A total of twelve coefficients are required. | | | -| | | | | -+------------------------------------------+------------------------------------------------------------+--------+----------+ -| thermal_conductivity | Specify which thermal conductivity model to use for | String | None | -| | fluid. Available options include: | | | -| | | | | -| | * ``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 | ++============================================+============================================================+========+==========+ +| 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 | | | +| | | | | +| | 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.eddy | Specify eddy viscosty model. | String | None | +| | | | | +| | Available options include: | | | +| | | | | +| | * ``None`` No eddy viscosity model | | | +| | * ``Smagorinsky-Lilly`` :cite:p:`Smag63,Lilly66` | | | +| | | | | ++--------------------------------------------+------------------------------------------------------------+--------+----------+ +| 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 ``Samgorinsky-Lilly`` | | | +| | eddy viscosity model. | | | ++--------------------------------------------+------------------------------------------------------------+--------+----------+ +| species | Specify the species that constitute the fluid. | String | 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 *ideal gas* constraints and the species equations | | | +| | are not solved. | | | ++--------------------------------------------+------------------------------------------------------------+--------+----------+ +| specific_heat | Specify which specific heat model to use for the fluid. | String | None | +| | Available options include: | | | +| | | | | +| | * ``constant`` - the fluid has a constant specific heat | | | +| | | | | +| | * ``NASA7-poly`` the fluid specific heat is defined by a | | | +| | low-temperature (T < 1000K) polynomial and a | | | +| | high-temprature (T > 1000K) polynomial. | | | +| | | | | +| | NASA7 polynomial format: | | | +| | | | | +| | :math:`c_p(T) = \sum_{i=0}^5 a_iT^i` | | | +| | | | | +| | * ``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 | 0. 0. | +| | coefficients are required if the fluid specific heat | | | +| | model is ``NASA7-poly``. | | | +| | | | | +| | Each polynomial is defined by six coefficients (``a0``, | | | +| | ..., ``a5``), and two values are required for each | | | +| | coefficient. The first value is the low temperature | | | +| | polynomial coefficient (T < 1000K) and the second is the | | | +| | coefficient for the high temperature polynomial | | | +| | (T > 1000K). A total of twelve coefficients are required. | | | +| | | | | ++--------------------------------------------+------------------------------------------------------------+--------+----------+ +| thermal_conductivity | Specify which thermal conductivity model to use for | String | None | +| | fluid. Available options include: | | | +| | | | | +| | * ``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