LamBremhorstKE.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::incompressible::RASModels::LamBremhorstKE
29
30Group
31 grpIcoRASTurbulence
32
33Description
34 Lam and Bremhorst low-Reynolds number k-epsilon turbulence model
35 for incompressible flows
36
37 This turbulence model is described in:
38 \verbatim
39 Lam, C. K. G., & Bremhorst, K. (1981).
40 A modified form of the k-ε model for predicting wall turbulence.
41 Journal of Fluids Engineering, 103(3), 456-460.
42 \endverbatim
43
44SourceFiles
45 LamBremhorstKE.C
46
47\*---------------------------------------------------------------------------*/
48
49#ifndef LamBremhorstKE_H
50#define LamBremhorstKE_H
51
53#include "eddyViscosity.H"
54
55// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56
57namespace Foam
58{
59namespace incompressible
60{
61namespace RASModels
62{
63
64/*---------------------------------------------------------------------------*\
65 Class LamBremhorstKE Declaration
66\*---------------------------------------------------------------------------*/
69:
70 public eddyViscosity<incompressible::RASModel>
71{
72 // Private Member Functions
73
74 //- No copy construct
75 LamBremhorstKE(const LamBremhorstKE&) = delete;
76
77 //- No copy assignment
78 void operator=(const LamBremhorstKE&) = delete;
79
80 tmp<volScalarField> Rt() const;
81 tmp<volScalarField> fMu(const volScalarField& Rt) const;
82 tmp<volScalarField> f1(const volScalarField& fMu) const;
83 tmp<volScalarField> f2(const volScalarField& Rt) const;
84 void correctNut(const volScalarField& fMu);
85
86
87protected:
88
89 // Protected data
98
99 //- Wall distance
100 // Note: different to wall distance in parent RASModel
101 // which is for near-wall cells only
102 const volScalarField& y_;
103
104
105 // Protected Member Functions
106
107 virtual void correctNut();
108
109
110public:
111
112 //- Runtime type information
113 TypeName("LamBremhorstKE");
114
115
116 // Constructors
117
118 //- Construct from components
120 (
122 const geometricOneField& rho,
123 const volVectorField& U,
124 const surfaceScalarField& alphaRhoPhi,
125 const surfaceScalarField& phi,
126 const transportModel& transport,
127 const word& propertiesName = turbulenceModel::propertiesName,
128 const word& type = typeName
129 );
130
131
132 //- Destructor
133 virtual ~LamBremhorstKE() = default;
134
135
136 // Member Functions
137
138 //- Re-read model coefficients if they have changed
139 virtual bool read();
140
141 //- Return the effective diffusivity for k
143 {
145 (
146 new volScalarField("DkEff", nut_ + nu())
147 );
148 }
149
150 //- Return the effective diffusivity for epsilon
152 {
154 (
155 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
156 );
157 }
158
159 //- Return the turbulence kinetic energy
160 virtual tmp<volScalarField> k() const
161 {
162 return k_;
163 }
164
165 //- Return the turbulence kinetic energy dissipation rate
166 virtual tmp<volScalarField> epsilon() const
167 {
168 return epsilon_;
169 }
170
171 //- Solve the turbulence equations and correct the turbulence viscosity
172 virtual void correct();
173};
174
175
176// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177
178} // End namespace RASModels
179} // End namespace incompressible
180} // End namespace Foam
181
182// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183
184#endif
185
186// ************************************************************************* //
surfaceScalarField & phi
Eddy viscosity turbulence model base class.
Definition: eddyViscosity.H:58
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
Lam and Bremhorst low-Reynolds number k-epsilon turbulence model for incompressible flows.
virtual void correct()
Solve the turbulence equations and correct the turbulence viscosity.
virtual ~LamBremhorstKE()=default
Destructor.
tmp< volScalarField > DepsilonEff() const
Return the effective diffusivity for epsilon.
const volScalarField & y_
Wall distance.
TypeName("LamBremhorstKE")
Runtime type information.
virtual tmp< volScalarField > k() const
Return the turbulence kinetic energy.
virtual tmp< volScalarField > epsilon() const
Return the turbulence kinetic energy dissipation rate.
virtual bool read()
Re-read model coefficients if they have changed.
tmp< volScalarField > DkEff() const
Return the effective diffusivity for k.
BasicTurbulenceModel::transportModel transportModel
static const word propertiesName
Default name of the phase properties dictionary.
Definition: phaseSystem.H:290
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
U
Definition: pEqn.H:72
Namespace for OpenFOAM.
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:82
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:598
volScalarField & nu
volScalarField & alpha
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73