All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LaunderSharmaKE.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-2020 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::LaunderSharmaKE
26 
27 Description
28  Launder and Sharma low-Reynolds k-epsilon turbulence model for
29  incompressible and compressible and combusting flows including
30  rapid distortion theory (RDT) based compression term.
31 
32  References:
33  \verbatim
34  Launder, B. E., & Sharma, B. I. (1974).
35  Application of the energy-dissipation model of turbulence to the
36  calculation of flow near a spinning disc.
37  Letters in heat and mass transfer, 1(2), 131-137.
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  LaunderSharmaKECoeffs
48  {
49  Cmu 0.09;
50  C1 1.44;
51  C2 1.92;
52  C3 -0.33;
53  alphah 1.0; // only for compressible
54  alphahk 1.0; // only for compressible
55  alphaEps 0.76923;
56  }
57  \endverbatim
58 
59 SourceFiles
60  LaunderSharmaKE.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef LaunderSharmaKE_H
65 #define LaunderSharmaKE_H
66 
67 #include "RASModel.H"
68 #include "eddyViscosity.H"
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 namespace RASModels
75 {
76 
77 /*---------------------------------------------------------------------------*\
78  Class LaunderSharmaKE Declaration
79 \*---------------------------------------------------------------------------*/
80 
81 template<class BasicMomentumTransportModel>
82 class LaunderSharmaKE
83 :
84  public eddyViscosity<RASModel<BasicMomentumTransportModel>>
85 {
86 protected:
87 
88  // Protected data
89 
90  // Model coefficients
91 
98 
99 
100  // Fields
104 
105 
106  // Private Member Functions
107 
108  tmp<volScalarField> fMu() const;
109  tmp<volScalarField> f2() const;
110 
111  virtual void correctNut();
112  virtual tmp<fvScalarMatrix> kSource() const;
113  virtual tmp<fvScalarMatrix> epsilonSource() const;
114 
115 
116 public:
118  typedef typename BasicMomentumTransportModel::alphaField alphaField;
119  typedef typename BasicMomentumTransportModel::rhoField rhoField;
120  typedef typename BasicMomentumTransportModel::transportModel transportModel;
121 
122 
123  //- Runtime type information
124  TypeName("LaunderSharmaKE");
125 
126 
127  // Constructors
128 
129  //- Construct from components
131  (
132  const alphaField& alpha,
133  const rhoField& rho,
134  const volVectorField& U,
135  const surfaceScalarField& alphaRhoPhi,
136  const surfaceScalarField& phi,
137  const transportModel& transport,
138  const word& type = typeName
139  );
140 
141  //- Disallow default bitwise copy construction
142  LaunderSharmaKE(const LaunderSharmaKE&) = delete;
143 
144 
145  //- Destructor
146  virtual ~LaunderSharmaKE()
147  {}
148 
149 
150  // Member Functions
151 
152  //- Re-read model coefficients if they have changed
153  virtual bool read();
154 
155  //- Return the effective diffusivity for k
156  tmp<volScalarField> DkEff() const
157  {
158  return volScalarField::New
159  (
160  "DkEff",
161  (this->nut_/sigmak_ + this->nu())
162  );
163  }
164 
165  //- Return the effective diffusivity for epsilon
167  {
168  return volScalarField::New
169  (
170  "DepsilonEff",
171  (this->nut_/sigmaEps_ + this->nu())
172  );
173  }
174 
175  //- Return the turbulence kinetic energy
176  virtual tmp<volScalarField> k() const
177  {
178  return k_;
179  }
180 
181  //- Return the turbulence kinetic energy dissipation rate
182  virtual tmp<volScalarField> epsilon() const
183  {
184  return epsilon_;
185  }
186 
187  //- Solve the turbulence equations and correct the turbulence viscosity
188  virtual void correct();
189 
190 
191  // Member Operators
192 
193  //- Disallow default bitwise assignment
194  void operator=(const LaunderSharmaKE&) = delete;
195 };
196 
197 
198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
199 
200 } // End namespace RASModels
201 } // End namespace Foam
202 
203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
204 
205 #ifdef NoRepository
206  #include "LaunderSharmaKE.C"
207 #endif
208 
209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
210 
211 #endif
212 
213 // ************************************************************************* //
BasicMomentumTransportModel::alphaField alphaField
TypeName("LaunderSharmaKE")
Runtime type information.
virtual ~LaunderSharmaKE()
Destructor.
tmp< volScalarField > DepsilonEff() const
Return the effective diffusivity for epsilon.
virtual bool read()
Re-read model coefficients if they have changed.
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,.
virtual void correct()
Solve the turbulence equations and correct the turbulence viscosity.
Eddy viscosity turbulence model base class.
Definition: eddyViscosity.H:49
virtual tmp< fvScalarMatrix > kSource() const
BasicMomentumTransportModel::rhoField rhoField
virtual tmp< fvScalarMatrix > epsilonSource() const
tmp< volScalarField > DkEff() const
Return the effective diffusivity for k.
A class for handling words, derived from string.
Definition: word.H:59
tmp< volScalarField > f2() const
virtual tmp< volScalarField > k() const
Return the turbulence kinetic energy.
phi
Definition: correctPhi.H:3
virtual tmp< volScalarField > epsilon() const
Return the turbulence kinetic energy dissipation rate.
void operator=(const LaunderSharmaKE &)=delete
Disallow default bitwise assignment.
LaunderSharmaKE(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.
U
Definition: pEqn.H:72
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
tmp< volScalarField > fMu() const
A class for managing temporary objects.
Definition: PtrList.H:53
BasicMomentumTransportModel::transportModel transportModel
Launder and Sharma low-Reynolds k-epsilon turbulence model for incompressible and compressible and co...
Namespace for OpenFOAM.