LaheyKEpsilon.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) 2013-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::LaheyKEpsilon
26 
27 Description
28  Continuous-phase k-epsilon model including bubble-generated turbulence.
29 
30  Reference:
31  \verbatim
32  Lahey Jr, R. T. (2005).
33  The simulation of multidimensional multiphase flows.
34  Nuclear Engineering and Design, 235(10), 1043-1060.
35  \endverbatim
36 
37  The default model coefficients are
38  \verbatim
39  LaheyKEpsilonCoeffs
40  {
41  Cmu 0.09;
42  C1 1.44;
43  C2 1.92;
44  C3 -0.33;
45  sigmak 1.0;
46  sigmaEps 1.3;
47  Cp 0.25;
48  Cmub 0.6;
49  alphaInversion 0.3;
50  }
51  \endverbatim
52 
53 SourceFiles
54  LaheyKEpsilon.C
55 
56 \*---------------------------------------------------------------------------*/
57 
58 #ifndef LaheyKEpsilon_H
59 #define LaheyKEpsilon_H
60 
61 #include "kEpsilon.H"
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 namespace Foam
66 {
67 namespace RASModels
68 {
69 
70 /*---------------------------------------------------------------------------*\
71  Class LaheyKEpsilon Declaration
72 \*---------------------------------------------------------------------------*/
73 
74 template<class BasicMomentumTransportModel>
75 class LaheyKEpsilon
76 :
77  public kEpsilon<BasicMomentumTransportModel>
78 {
79  // Private Data
80 
82  <
83  typename BasicMomentumTransportModel::transportModel
84  > *gasTurbulencePtr_;
85 
86 
87  // Private Member Functions
88 
89  //- Return the turbulence model for the gas phase
91  <
92  typename BasicMomentumTransportModel::transportModel
93  >&
94  gasTurbulence() const;
95 
96 
97 protected:
98 
99  // Protected data
100 
101  // Model coefficients
107 
108 
109  // Protected Member Functions
110 
111  virtual void correctNut();
114  virtual tmp<fvScalarMatrix> kSource() const;
115  virtual tmp<fvScalarMatrix> epsilonSource() const;
116 
117 
118 public:
120  typedef typename BasicMomentumTransportModel::alphaField alphaField;
121  typedef typename BasicMomentumTransportModel::rhoField rhoField;
122  typedef typename BasicMomentumTransportModel::transportModel transportModel;
123 
124 
125  //- Runtime type information
126  TypeName("LaheyKEpsilon");
127 
128 
129  // Constructors
130 
131  //- Construct from components
133  (
134  const alphaField& alpha,
135  const rhoField& rho,
136  const volVectorField& U,
137  const surfaceScalarField& alphaRhoPhi,
138  const surfaceScalarField& phi,
139  const transportModel& transport,
140  const word& type = typeName
141  );
142 
143  //- Disallow default bitwise copy construction
144  LaheyKEpsilon(const LaheyKEpsilon&) = delete;
145 
146 
147  //- Destructor
148  virtual ~LaheyKEpsilon()
149  {}
150 
151 
152  // Member Functions
153 
154  //- Read model coefficients if they have changed
155  virtual bool read();
156 
157  //- Solve the turbulence equations and correct the turbulence viscosity
158  virtual void correct();
159 
160 
161  // Member Operators
162 
163  //- Disallow default bitwise assignment
164  void operator=(const LaheyKEpsilon&) = delete;
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace RASModels
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #ifdef NoRepository
176  #include "LaheyKEpsilon.C"
177 #endif
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #endif
182 
183 // ************************************************************************* //
TypeName("LaheyKEpsilon")
Runtime type information.
Templated abstract base class for multiphase compressible turbulence models.
dimensionedScalar alphaInversion_
virtual bool read()
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))
virtual void correct()
Solve the turbulence equations and correct the turbulence viscosity.
BasicMomentumTransportModel::alphaField alphaField
LaheyKEpsilon(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: LaheyKEpsilon.C:43
Continuous-phase k-epsilon model including bubble-generated turbulence.
Definition: LaheyKEpsilon.H:74
BasicMomentumTransportModel::rhoField rhoField
Standard k-epsilon turbulence model for incompressible and compressible flows including rapid distort...
Definition: kEpsilon.H:83
A class for handling words, derived from string.
Definition: word.H:59
phi
Definition: correctPhi.H:3
tmp< volScalarField > phaseTransferCoeff() const
virtual ~LaheyKEpsilon()
Destructor.
virtual tmp< fvScalarMatrix > kSource() const
U
Definition: pEqn.H:72
BasicMomentumTransportModel::transportModel transportModel
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 > bubbleG() const
void operator=(const LaheyKEpsilon &)=delete
Disallow default bitwise assignment.
virtual tmp< fvScalarMatrix > epsilonSource() const
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.