From a6a9db230eb08cb0016e33ffc9e7685cdcf68f72 Mon Sep 17 00:00:00 2001
From: Henry <Henry>
Date: Thu, 26 Feb 2015 20:03:48 +0000
Subject: [PATCH] TurbulenceModels: Updated documentation for incompressible
 models

---
 .../RAS/LamBremhorstKE/LamBremhorstKE.H       |  7 +++++++
 .../RAS/LienCubicKE/LienCubicKE.H             | 11 +++++++++++
 .../RAS/LienCubicKELowRe/LienCubicKELowRe.H   | 19 ++++++++-----------
 .../LienLeschzinerLowRe/LienLeschzinerLowRe.H |  9 +++++++++
 .../RAS/qZeta/qZeta.H                         | 19 +++++++++++--------
 5 files changed, 46 insertions(+), 19 deletions(-)

diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H
index 4041e045210..de7a9d1f35f 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H
@@ -31,6 +31,13 @@ Description
     Lam and Bremhorst low-Reynolds number k-epsilon turbulence model
     for incompressible flows
 
+    This turbulence model is described in:
+    \verbatim
+        Lam, C. K. G., & Bremhorst, K. (1981).
+        A modified form of the k-ε model for predicting wall turbulence.
+        Journal of Fluids Engineering, 103(3), 456-460.
+    \endverbatim
+
 SourceFiles
     LamBremhorstKE.C
 
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H
index 411244cc7fd..ecf3fdf4c95 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H
@@ -30,6 +30,17 @@ Group
 Description
     Lien cubic non-linear k-epsilon turbulence model for incompressible flows.
 
+    This turbulence model is described in:
+    \verbatim
+        Lien, F.S., Chen, W.L. & Leschziner, M.A. (1996).
+        Low-Reynolds-number eddy-viscosity modeling based on non-linear
+        stress-strain/vorticity relations.
+        Engineering Turbulence Modelling and Experiments 3, 91-100.
+    \endverbatim
+
+See Also
+    Foam::incompressible::RASModels::LienCubicKELowRe
+
 SourceFiles
     LienCubicKE.C
 
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowRe.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowRe.H
index 40faf67621d..09279319dcc 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowRe.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowRe.H
@@ -31,20 +31,17 @@ Description
     Lien cubic non-linear low-Reynolds k-epsilon turbulence models for
     incompressible flows.
 
-    References:
+    This turbulence model is described in:
     \verbatim
-        Lien, F.S., Chen, W.L., Leschziner, M.A.,
-        "Low-Reynolds-number eddy-viscosity modeling based on non-linear
-         stress-strain/vorticity relations"
-        Engineering Turbulence Modelling and Experiments 3
-        (Edited by Rodi, W. and Bergeles, G.), 91-100. 1996.
-        Elsevier Science Publishers.
-
-        Etemad, S., et al.,
-        "Turbulent flow and heat transfer in a square-sectioned U bend"
-        Progress in compuational fluid dynamics 6, 89-100. 2006.
+        Lien, F.S., Chen, W.L. & Leschziner, M.A. (1996).
+        Low-Reynolds-number eddy-viscosity modeling based on non-linear
+        stress-strain/vorticity relations.
+        Engineering Turbulence Modelling and Experiments 3, 91-100.
     \endverbatim
 
+See Also
+    Foam::incompressible::RASModels::LienCubicKE
+
 SourceFiles
     LienCubicKELowRe.C
 
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H
index 206abb09b25..093286c2841 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H
@@ -31,6 +31,15 @@ Description
     Lien and Leschziner low-Reynolds k-epsilon turbulence model for
     incompressible flows.
 
+    This turbulence model is described in:
+    \verbatim
+        Lien, F. S., & Leschziner, M. A. (1993).
+        A pressure-velocity solution strategy for compressible flow
+        and its application to shock/boundary-layer interaction
+        using second-moment turbulence closure.
+        Journal of fluids engineering, 115(4), 717-725.
+    \endverbatim
+
 SourceFiles
     LienLeschzinerLowRe.C
 
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H
index 9393e0237a3..600845160b6 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H
@@ -31,17 +31,20 @@ Description
     Gibson and Dafa'Alla's q-zeta two-equation low-Re turbulence model
     for incompressible flows
 
-    References:
+    This turbulence model is described in:
     \verbatim
-        "Calculation of oscillating boundary layers with the
-        q-[zeta] turbulence model"
-        A.A. Dafa'Alla, E. Juntasaro and M.M. Gibson
-
+        Dafa'Alla, A.A., Juntasaro, E. & Gibson, M.M. (1996).
+        Calculation of oscillating boundary layers with the
+        q-zeta turbulence model.
         Engineering Turbulence Modelling and Experiments 3:
         Proceedings of the Third International Symposium,
-        Crete, Greece, May 27-29, 1996, p. 141.
-
-        Editors: Wolfgang Rodi and G. Bergeles
+        Crete, Greece, May 27-29, 141.
+    \endverbatim
+    which is a development of the original q-zeta model described in:
+    \verbatim
+        Gibson, M. M., & Dafa'Alla, A. A. (1995).
+        Two-equation model for turbulent wall flow.
+        AIAA journal, 33(8), 1514-1518.
     \endverbatim
 
 SourceFiles
-- 
GitLab