TurbulenceModels: Updated documentation

src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2014-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License

src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2014-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/RNGkEpsilon/RNGkEpsilon.H

@@ -38,7 +38,7 @@ Description
         Physics of Fluids A, Vol. 4, No. 7, 1992, pp 1510-1520.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         RNGkEpsilonCoeffs
         {

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/kOmega/kOmega.H

@@ -33,16 +33,12 @@ Description
 
     References:
     \verbatim
-        "Turbulence Modeling for CFD"
+        Wilcox, D. C. (1998).
-        D. C. Wilcox,
+        Turbulence modeling for CFD
-        DCW Industries, Inc., La Canada,
+        (Vol. 2, pp. 103-217). La Canada, CA: DCW industries.
-        California, 1988.
-
-        See also:
-        http://www.cfd-online.com/Wiki/Wilcox's_k-omega_model
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         kOmegaCoeffs
         {

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/kkLOmega/kkLOmega.H

@@ -33,12 +33,13 @@ Description
 
     Turbulence model described in:
     \verbatim
-        D. Keith Walters, Davor Cokljat
+        Walters, D. K., & Cokljat, D. (2008).
-        "A Three-Equation Eddy-Viscosity Model for Reynold-Averaged
+        A three-equation eddy-viscosity model for Reynolds-averaged
-        Navier-Stokes Simulations of Transitional Flow"
+        Navier–Stokes simulations of transitional flow.
+        Journal of Fluids Engineering, 130(12), 121401.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         kkLOmegaCoeffs
         {

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/v2f/v2f.H

@@ -53,17 +53,17 @@ Description
 
     References:
     \verbatim
-        Lien F-S, Kalitzin G,
+        Lien, F. S., & Kalitzin, G. (2001).
-        "Computations of transonic flow with the v2-f turbulence model",
+        Computations of transonic flow with the v2f turbulence model.
-        Int. J. Heat Fluid Flow 22, 2001, pp 53-61
+        International Journal of Heat and Fluid Flow, 22(1), 53-61.
 
-        Davidson L, Nielsen P, Sveningsson A,
+        Davidson, L., Nielsen, P., & Sveningsson, A. (2003).
-        "Modifications of the v2-f model for computing the flow in a
+        Modifications of the v2-f model for computing the flow in a
-         3D wall jet",
+        3D wall jet.
-        Turbulence, Heat and Mass Transfer 4, 2003, pp 577-584
+        Turbulence, Heat and Mass Transfer, 4, 577-584
     \endverbatim
 
-    The default model coefficients are given as:
+    The default model coefficients are
     \verbatim
         v2fCoeffs
         {
@@ -85,7 +85,7 @@ Note
     k variants (nutk...) for this case will not behave correctly.
 
 SeeAlso
-    Foam::incompressible::RASModels::kEpsilon
+    Foam::RASModels::kEpsilon
     Foam::kLowReWallFunctionFvPatchScalarField
     Foam::epsilonLowReWallFunctionFvPatchScalarField
     Foam::v2WallFunctionFvPatchScalarField

src/TurbulenceModels/phaseCompressible/LES/Niceno/NicenoKEqn.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2013-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2013-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -33,15 +33,13 @@ Description
 
     Reference:
     \verbatim
-        "One-equation sub-grid scale (SGS) modelling for Euler-Euler
+        Niceno, B., Dhotre, M. T., & Deen, N. G. (2008).
-        large eddy simulation (EELES) of dispersed bubbly flow"
+        One-equation sub-grid scale (SGS) modelling for
-        B. Niceno,
+        Euler–Euler large eddy simulation (EELES) of dispersed bubbly flow.
-        M.T. Dhotre,
+        Chemical Engineering Science, 63(15), 3923-3931.
-        N.G. Dee
-        Chemical Engineering Science 63 (2008) pp. 3923-3931.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are:
     \verbatim
         NicenoKEqnCoeffs
         {

src/TurbulenceModels/phaseCompressible/LES/SmagorinskyZhang/SmagorinskyZhang.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2013-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2013-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -32,15 +32,13 @@ Description
 
     Reference:
     \verbatim
-        "Numerical simulation of the dynamic flow behavior in a bubble column:
+        Zhang, D., Deen, N. G., & Kuipers, J. A. M. (2006).
-        A study of closures for turbulence and interface forces"
+        Numerical simulation of the dynamic flow behavior in a bubble column:
-        D. Zhang,
+        a study of closures for turbulence and interface forces.
-        N.G. Deen,
+        Chemical Engineering Science, 61(23), 7593-7608.
-        J.A.M. Kuipers,
-        Chemical Engineering Science 61 (2006) pp 7593-7608.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         SmagorinskyZhangCoeffs
         {

src/TurbulenceModels/phaseCompressible/LES/continuousGasKEqn/continuousGasKEqn.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2013-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2013-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -39,7 +39,7 @@ Description
     This model is unpublished and is provided as a stable numerical framework
     on which a more physical model may be built.
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         continuousKEqnCoeffs
         {

src/TurbulenceModels/phaseCompressible/RAS/LaheyKEpsilon/LaheyKEpsilon.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2013-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2013-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -32,13 +32,12 @@ Description
 
     Reference:
     \verbatim
-        "The simulation of multidimensional multiphase flows",
+        Lahey Jr, R. T. (2005).
-        Lahey R.T.,
+        The simulation of multidimensional multiphase flows.
-        Nucl. Eng. & Design
+        Nuclear Engineering and Design, 235(10), 1043-1060.
-        2005 (235) pp.1043-1060.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         LaheyKEpsilonCoeffs
         {

src/TurbulenceModels/phaseCompressible/RAS/continuousGasKEpsilon/continuousGasKEpsilon.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2013-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2013-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -40,7 +40,7 @@ Description
     This model is unpublished and is provided as a stable numerical framework
     on which a more physical model may be built.
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         continuousGasKEpsilonCoeffs
         {

src/TurbulenceModels/phaseCompressible/RAS/mixtureKEpsilon/mixtureKEpsilon.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2013-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2013-2015 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -32,21 +32,20 @@ Description
 
     The basic structure of the model is based on:
     \verbatim
-        "Modelling of dispersed bubble and droplet ow at high phase fractions"
+        Behzadi, A., Issa, R. I., & Rusche, H. (2004).
-        A. Behzadi, R.I. Issa , H. Rusche,
+        Modelling of dispersed bubble and droplet flow at high phase fractions.
-        Chemical Engineering Science (59) 2004 pp.759-770.
+        Chemical Engineering Science, 59(4), 759-770.
     \endverbatim
 
     but an effective density for the gas is used in the averaging and an
     alternative model for bubble-generated turbulence from:
     \verbatim
-        "The simulation of multidimensional multiphase flows",
+        Lahey Jr, R. T. (2005).
-        Lahey R.T.,
+        The simulation of multidimensional multiphase flows.
-        Nucl. Eng. & Design
+        Nuclear Engineering and Design, 235(10), 1043-1060.
-        (235) 2005 pp.1043-1060.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         mixtureKEpsilonCoeffs
         {

src/TurbulenceModels/turbulenceModels/LES/Smagorinsky/Smagorinsky.H

@@ -30,11 +30,19 @@ Group
 Description
     The Smagorinsky SGS model.
 
-    Algebraic eddy viscosity SGS model founded on the assumption that
+    Reference:
-    local equilibrium prevails.
-    Thus,
     \verbatim
+        Smagorinsky, J. (1963).
+        General circulation experiments with the primitive equations: I.
+        The basic experiment*.
+        Monthly weather review, 91(3), 99-164.
+    \endverbatim
 
+    The form of the Smagorinsky model implemented is obtained from the
+    k-equation model assuming local equilibrium which provides estimates of both
+    k and epsilon separate from the sub-grid scale viscosity:
+
+    \verbatim
         B = 2/3*k*I - 2*nuSgs*dev(D)
 
     where
@@ -44,7 +52,7 @@ Description
         nuSgs = Ck*sqrt(k)*delta
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         SmagorinskyCoeffs
         {
@@ -53,6 +61,9 @@ Description
         }
     \endverbatim
 
+SeeAlso
+    Foam::LESModels::kEqn
+
 SourceFiles
     Smagorinsky.C
 

src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H

@@ -38,16 +38,19 @@ Description
         Flow, Turbulence and Combustion, 62(3), 183-200.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         WALECoeffs
         {
             Ck                  0.094;
-            Ce                  1.048;
+            Ce                  1.048;e
             Cw                  0.325;
         }
     \endverbatim
 
+SeeAlso
+    Foam::LESModels::Smagorinsky
+
 SourceFiles
     WALE.C
 

src/TurbulenceModels/turbulenceModels/LES/kEqn/kEqn.H

@@ -31,24 +31,17 @@ Description
     One Equation Eddy Viscosity Model
 
     Eddy viscosity SGS model using a modeled balance equation to simulate the
-    behaviour of k, hence,
+    behaviour of k.
+
+    Reference:
     \verbatim
-        d/dt(rho*k) + div(rho*U*k) - div(rho*nuEff*grad(k))
+        Yoshizawa, A. (1986).
-        =
+        Statistical theory for compressible turbulent shear flows,
-        -rho*D:B - Ce*rho*k^(3/2)/delta
+        with the application to subgrid modeling.
-
+        Physics of Fluids (1958-1988), 29(7), 2152-2164.
-    and
-
-        B = 2/3*k*I - 2*nuSgs*dev(D)
-
-    where
-
-        D = symm(grad(U));
-        nuSgs = Ck*sqrt(k)*delta
-        nuEff = nuSgs + nu
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         kEqnCoeffs
         {

src/TurbulenceModels/turbulenceModels/RAS/LaunderSharmaKE/LaunderSharmaKE.H

@@ -45,7 +45,7 @@ Description
         Journal of Energy, 7(4), 345-353.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         LaunderSharmaKECoeffs
         {

src/TurbulenceModels/turbulenceModels/RAS/RNGkEpsilon/RNGkEpsilon.H

@@ -33,7 +33,7 @@ Description
 
     Reference:
     \verbatim
-        Yakhot, V. S. A. S. T. B. C. G., Orszag, S. A., Thangam, S.,
+        Yakhot, V., Orszag, S. A., Thangam, S.,
         Gatski, T. B., & Speziale, C. G. (1992).
         Development of turbulence models for shear flows
         by a double expansion technique.
@@ -45,7 +45,7 @@ Description
         Journal of Energy, 7(4), 345-353.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         RNGkEpsilonCoeffs
         {

src/TurbulenceModels/turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.H

@@ -48,7 +48,7 @@ Description
     is implemented in which Stilda is clipped at Cs*Omega with the default value
     of Cs = 0.3.
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         SpalartAllmarasCoeffs
         {

src/TurbulenceModels/turbulenceModels/RAS/kEpsilon/kEpsilon.H

@@ -48,7 +48,7 @@ Description
             Journal of Energy, 7(4), 345-353.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         kEpsilonCoeffs
         {

src/TurbulenceModels/turbulenceModels/RAS/kOmegaSST/kOmegaSST.H

@@ -65,7 +65,7 @@ Description
     uncertainty in their origin, range of applicability and that if y+ becomes
     sufficiently small blending u_tau in this manner clearly becomes nonsense.
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         kOmegaSSTCoeffs
         {

src/TurbulenceModels/turbulenceModels/RAS/realizableKE/realizableKE.H

@@ -31,18 +31,20 @@ Description
     Realizable k-epsilon turbulence model for incompressible and compressible
     flows.
 
-    Model described in the paper:
+    References:
     \verbatim
-        "A New k-epsilon Eddy Viscosity Model for High Reynolds Number
+        Shih, T. H., Liou, W. W., Shabbir, A., Yang, Z., & Zhu, J. (1994).
-        Turbulent Flows"
+        A new k-epsilon eddy viscosity model for high Reynolds number
+        turbulent flows: Model development and validation.
+        NASA STI/Recon Technical Report N, 95, 11442.
 
-        Tsan-Hsing Shih, William W. Liou, Aamir Shabbir, Zhigang Tang and
+        Shih, T. H., Liou, W. W., Shabbir, A., Yang, Z., & Zhu, J. (1995).
-        Jiang Zhu
+        A New k-epsilon Eddy Viscosity Model for High Reynolds Number
-
+        Turbulent Flows.
-        Computers and Fluids Vol. 24, No. 3, pp. 227-238, 1995
+        Computers and Fluids, 24(3), 227-238.
     \endverbatim
 
-    The default model coefficients correspond to the following:
+    The default model coefficients are
     \verbatim
         realizableKECoeffs
         {