From 184a95a96a901c61e846fc84c32d1e9b697cdfb5 Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Tue, 1 Dec 2015 09:54:47 +0000
Subject: [PATCH] ENH: Turbulence models - header documentation updates
---
.../RAS/LamBremhorstKE/LamBremhorstKE.H | 2 +-
.../turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H | 2 +-
.../RAS/LienLeschziner/LienLeschziner.H | 2 +-
.../RAS/ShihQuadraticKE/ShihQuadraticKE.H | 2 +-
.../turbulentTransportModels/RAS/kkLOmega/kkLOmega.H | 2 +-
.../incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H | 2 +-
.../DES/SpalartAllmarasDES/SpalartAllmarasDES.H | 2 +-
.../DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H | 2 +-
.../turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.H | 2 +-
src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H | 2 +-
10 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H
index 603b5295f18..e0d1fda37b0 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LamBremhorstKE/LamBremhorstKE.H
@@ -131,7 +131,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for k
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H
index 8580991b9bc..f38e40a4c7f 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H
@@ -156,7 +156,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for k
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschziner/LienLeschziner.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschziner/LienLeschziner.H
index d861281f0fd..e74a64f443f 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschziner/LienLeschziner.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschziner/LienLeschziner.H
@@ -144,7 +144,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for k
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.H
index d81435cf093..5a61675371d 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.H
@@ -131,7 +131,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for k
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/kkLOmega/kkLOmega.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/kkLOmega/kkLOmega.H
index 68ba3793804..198c0bf3db8 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/kkLOmega/kkLOmega.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/kkLOmega/kkLOmega.H
@@ -237,7 +237,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for k
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H
index 600845160b6..7be89ff9c99 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/qZeta/qZeta.H
@@ -138,7 +138,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the lower allowable limit for q (default: SMALL)
diff --git a/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasDES/SpalartAllmarasDES.H b/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasDES/SpalartAllmarasDES.H
index 60294f61d86..2ffbbbd714b 100644
--- a/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasDES/SpalartAllmarasDES.H
+++ b/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasDES/SpalartAllmarasDES.H
@@ -210,7 +210,7 @@ public:
// Member Functions
- //- Read LESProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for nuTilda
diff --git a/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H b/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
index 2bfaf6089a1..1db9a9fad88 100644
--- a/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
+++ b/src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
@@ -146,7 +146,7 @@ public:
// Member Functions
- //- Read LESProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
};
diff --git a/src/TurbulenceModels/turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.H b/src/TurbulenceModels/turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.H
index 51d303361c4..c84373b9e2c 100644
--- a/src/TurbulenceModels/turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.H
+++ b/src/TurbulenceModels/turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.H
@@ -183,7 +183,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for nuTilda
diff --git a/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H b/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H
index 099e0cb0790..a76c4ee689a 100644
--- a/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H
+++ b/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H
@@ -208,7 +208,7 @@ public:
// Member Functions
- //- Read RASProperties dictionary
+ //- Re-read model coefficients if they have changed
virtual bool read();
//- Return the effective diffusivity for k
--
GitLab