ShihQuadraticKE: renamed from nonlinearKEShih and added reference

src/TurbulenceModels/incompressible/Make/files

@@ -7,7 +7,7 @@ turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.C
 turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.C
 turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowRe.C
 turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.C
-turbulentTransportModels/RAS/nonlinearKEShih/nonlinearKEShih.C
+turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.C
 
 BCs = turbulentTransportModels/RAS/derivedFvPatchFields
 

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/nonlinearKEShih/nonlinearKEShih.C → src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.C

@@ -23,7 +23,7 @@ License
 
 \*---------------------------------------------------------------------------*/
 
-#include "nonlinearKEShih.H"
+#include "ShihQuadraticKE.H"
 #include "bound.H"
 #include "wallFvPatch.H"
 #include "nutkWallFunctionFvPatchScalarField.H"
@@ -40,19 +40,19 @@ namespace RASModels
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
-defineTypeNameAndDebug(nonlinearKEShih, 0);
-addToRunTimeSelectionTable(RASModel, nonlinearKEShih, dictionary);
+defineTypeNameAndDebug(ShihQuadraticKE, 0);
+addToRunTimeSelectionTable(RASModel, ShihQuadraticKE, dictionary);
 
 // * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
 
-void nonlinearKEShih::correctNut()
+void ShihQuadraticKE::correctNut()
 {
     nut_ = Cmu_*sqr(k_)/epsilon_;
     #include "wallNonlinearViscosityI.H"
 }
 
 
-void nonlinearKEShih::correctNonlinearStress(const volTensorField& gradU)
+void ShihQuadraticKE::correctNonlinearStress(const volTensorField& gradU)
 {
     nonlinearStress_ = symm
     (
@@ -72,7 +72,7 @@ void nonlinearKEShih::correctNonlinearStress(const volTensorField& gradU)
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
-nonlinearKEShih::nonlinearKEShih
+ShihQuadraticKE::ShihQuadraticKE
 (
     const geometricOneField& alpha,
     const geometricOneField& rho,
@@ -259,7 +259,7 @@ nonlinearKEShih::nonlinearKEShih
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-bool nonlinearKEShih::read()
+bool ShihQuadraticKE::read()
 {
     if (nonlinearEddyViscosity<incompressible::RASModel>::read())
     {
@@ -286,7 +286,7 @@ bool nonlinearKEShih::read()
 }
 
 
-void nonlinearKEShih::correct()
+void ShihQuadraticKE::correct()
 {
     nonlinearEddyViscosity<incompressible::RASModel>::correct();
 

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/nonlinearKEShih/nonlinearKEShih.H → src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.H

@@ -22,22 +22,29 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::incompressible::RASModels::nonlinearKEShih
+    Foam::incompressible::RASModels::ShihQuadraticKE
 
 Group
     grpIcoRASTurbulence
 
 Description
-    Shih's quadratic non-linear k-epsilon turbulence model for
+    Shih's quadratic algebraic Reynolds stress k-epsilon turbulence model for
     incompressible flows
 
+    This turbulence model is described in:
+    \verbatim
+        Shih, T. H., Zhu, J., & Lumley, J. L. (1993).
+        A realizable Reynolds stress algebraic equation model.
+        NASA technical memorandum 105993.
+    \endverbatim
+
 SourceFiles
-    nonlinearKEShih.C
+    ShihQuadraticKE.C
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef nonlinearKEShih_H
-#define nonlinearKEShih_H
+#ifndef ShihQuadraticKE_H
+#define ShihQuadraticKE_H
 
 #include "turbulentTransportModel.H"
 #include "nonlinearEddyViscosity.H"
@@ -52,10 +59,10 @@ namespace RASModels
 {
 
 /*---------------------------------------------------------------------------*\
-                      Class nonlinearKEShih Declaration
+                      Class ShihQuadraticKE Declaration
 \*---------------------------------------------------------------------------*/
 
-class nonlinearKEShih
+class ShihQuadraticKE
 :
     public nonlinearEddyViscosity<incompressible::RASModel>
 {
@@ -101,13 +108,13 @@ protected:
 public:
 
     //- Runtime type information
-    TypeName("nonlinearKEShih");
+    TypeName("ShihQuadraticKE");
 
 
     // Constructors
 
         //- Construct from components
-        nonlinearKEShih
+        ShihQuadraticKE
         (
             const geometricOneField& alpha,
             const geometricOneField& rho,
@@ -121,7 +128,7 @@ public:
 
 
     //- Destructor
-    virtual ~nonlinearKEShih()
+    virtual ~ShihQuadraticKE()
     {}