All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
RNGkEpsilon.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::RASModels::RNGkEpsilon
26 
27 Description
28  Renormalisation group k-epsilon turbulence model for incompressible and
29  compressible flows.
30 
31  Reference:
32  \verbatim
33  Yakhot, V., Orszag, S. A., Thangam, S.,
34  Gatski, T. B., & Speziale, C. G. (1992).
35  Development of turbulence models for shear flows
36  by a double expansion technique.
37  Physics of Fluids A: Fluid Dynamics (1989-1993), 4(7), 1510-1520.
38 
39  For the RDT-based compression term:
40  El Tahry, S. H. (1983).
41  k-epsilon equation for compressible reciprocating engine flows.
42  Journal of Energy, 7(4), 345-353.
43  \endverbatim
44 
45  The default model coefficients are
46  \verbatim
47  RNGkEpsilonCoeffs
48  {
49  Cmu 0.0845;
50  C1 1.42;
51  C2 1.68;
52  C3 -0.33;
53  sigmak 0.71942;
54  sigmaEps 0.71942;
55  eta0 4.38;
56  beta 0.012;
57  }
58  \endverbatim
59 
60 SourceFiles
61  RNGkEpsilon.C
62 
63 \*---------------------------------------------------------------------------*/
64 
65 #ifndef RNGkEpsilon_H
66 #define RNGkEpsilon_H
67 
68 #include "RASModel.H"
69 #include "eddyViscosity.H"
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 namespace Foam
74 {
75 namespace RASModels
76 {
77 
78 /*---------------------------------------------------------------------------*\
79  Class RNGkEpsilon Declaration
80 \*---------------------------------------------------------------------------*/
81 
82 template<class BasicMomentumTransportModel>
83 class RNGkEpsilon
84 :
85  public eddyViscosity<RASModel<BasicMomentumTransportModel>>
86 {
87  // Private Member Functions
88 
89  using IOobject::modelName;
90 
91 
92 protected:
93 
94  // Protected data
95 
96  // Model coefficients
97 
106 
107 
108  // Fields
112 
113 
114  // Protected Member Functions
115 
116  virtual void correctNut();
117  virtual tmp<fvScalarMatrix> kSource() const;
118  virtual tmp<fvScalarMatrix> epsilonSource() const;
119 
120 
121 public:
123  typedef typename BasicMomentumTransportModel::alphaField alphaField;
124  typedef typename BasicMomentumTransportModel::rhoField rhoField;
125  typedef typename BasicMomentumTransportModel::transportModel transportModel;
126 
127 
128  //- Runtime type information
129  TypeName("RNGkEpsilon");
130 
131 
132  // Constructors
133 
134  //- Construct from components
136  (
137  const alphaField& alpha,
138  const rhoField& rho,
139  const volVectorField& U,
140  const surfaceScalarField& alphaRhoPhi,
141  const surfaceScalarField& phi,
142  const transportModel& transport,
143  const word& type = typeName
144  );
145 
146  //- Disallow default bitwise copy construction
147  RNGkEpsilon(const RNGkEpsilon&) = delete;
148 
149 
150  //- Destructor
151  virtual ~RNGkEpsilon()
152  {}
153 
154 
155  // Member Functions
156 
157  //- Re-read model coefficients if they have changed
158  virtual bool read();
159 
160  //- Return the effective diffusivity for k
161  tmp<volScalarField> DkEff() const
162  {
163  return volScalarField::New
164  (
165  "DkEff",
166  (this->nut_/sigmak_ + this->nu())
167  );
168  }
169 
170  //- Return the effective diffusivity for epsilon
172  {
173  return volScalarField::New
174  (
175  "DepsilonEff",
176  (this->nut_/sigmaEps_ + this->nu())
177  );
178  }
179 
180  //- Return the turbulence kinetic energy
181  virtual tmp<volScalarField> k() const
182  {
183  return k_;
184  }
185 
186  //- Return the turbulence kinetic energy dissipation rate
187  virtual tmp<volScalarField> epsilon() const
188  {
189  return epsilon_;
190  }
191 
192  //- Solve the turbulence equations and correct the turbulence viscosity
193  virtual void correct();
194 
195 
196  // Member Operators
197 
198  //- Disallow default bitwise assignment
199  void operator=(const RNGkEpsilon&) = delete;
200 };
201 
202 
203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
204 
205 } // End namespace RASModels
206 } // End namespace Foam
207 
208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
209 
210 #ifdef NoRepository
211  #include "RNGkEpsilon.C"
212 #endif
213 
214 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
215 
216 #endif
217 
218 // ************************************************************************* //
dimensionedScalar beta_
Definition: RNGkEpsilon.H:104
dimensionedScalar C1_
Definition: RNGkEpsilon.H:98
TypeName("RNGkEpsilon")
Runtime type information.
virtual tmp< fvScalarMatrix > kSource() const
Definition: RNGkEpsilon.C:50
virtual void correct()
Solve the turbulence equations and correct the turbulence viscosity.
Definition: RNGkEpsilon.C:239
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
static tmp< GeometricField< scalar, fvPatchField, volMesh > > New(const word &name, const Internal &, const PtrList< fvPatchField< scalar >> &)
Return a temporary field constructed from name,.
BasicMomentumTransportModel::rhoField rhoField
Definition: RNGkEpsilon.H:123
Eddy viscosity turbulence model base class.
Definition: eddyViscosity.H:49
BasicMomentumTransportModel::alphaField alphaField
Definition: RNGkEpsilon.H:122
virtual tmp< fvScalarMatrix > epsilonSource() const
Definition: RNGkEpsilon.C:66
tmp< volScalarField > DkEff() const
Return the effective diffusivity for k.
Definition: RNGkEpsilon.H:160
dimensionedScalar sigmak_
Definition: RNGkEpsilon.H:101
RNGkEpsilon(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &type=typeName)
Construct from components.
Definition: RNGkEpsilon.C:84
A class for handling words, derived from string.
Definition: word.H:59
tmp< volScalarField > DepsilonEff() const
Return the effective diffusivity for epsilon.
Definition: RNGkEpsilon.H:170
phi
Definition: correctPhi.H:3
virtual ~RNGkEpsilon()
Destructor.
Definition: RNGkEpsilon.H:150
virtual tmp< volScalarField > k() const
Return the turbulence kinetic energy.
Definition: RNGkEpsilon.H:180
dimensionedScalar Cmu_
Definition: RNGkEpsilon.H:97
void operator=(const RNGkEpsilon &)=delete
Disallow default bitwise assignment.
virtual tmp< volScalarField > epsilon() const
Return the turbulence kinetic energy dissipation rate.
Definition: RNGkEpsilon.H:186
BasicMomentumTransportModel::transportModel transportModel
Definition: RNGkEpsilon.H:124
dimensionedScalar eta0_
Definition: RNGkEpsilon.H:103
Renormalisation group k-epsilon turbulence model for incompressible and compressible flows...
Definition: RNGkEpsilon.H:82
virtual bool read()
Re-read model coefficients if they have changed.
Definition: RNGkEpsilon.C:216
U
Definition: pEqn.H:72
dimensionedScalar sigmaEps_
Definition: RNGkEpsilon.H:102
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
dimensionedScalar C2_
Definition: RNGkEpsilon.H:99
static word modelName(Name name, const word &model)
Return the name of the object within the given model.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.