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-2018 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 BasicTurbulenceModel>
75 class LaheyKEpsilon
76 :
77  public kEpsilon<BasicTurbulenceModel>
78 {
79  // Private data
80 
82  <
83  typename BasicTurbulenceModel::transportModel
84  > *gasTurbulencePtr_;
85 
86 
87  // Private Member Functions
88 
89  //- Return the turbulence model for the gas phase
91  <
92  typename BasicTurbulenceModel::transportModel
93  >&
94  gasTurbulence() const;
95 
96  // Disallow default bitwise copy construct and assignment
98  void operator=(const LaheyKEpsilon&);
99 
100 
101 protected:
102 
103  // Protected data
104 
105  // Model coefficients
111 
112 
113  // Protected Member Functions
114 
115  virtual void correctNut();
118  virtual tmp<fvScalarMatrix> kSource() const;
119  virtual tmp<fvScalarMatrix> epsilonSource() const;
120 
121 
122 public:
124  typedef typename BasicTurbulenceModel::alphaField alphaField;
125  typedef typename BasicTurbulenceModel::rhoField rhoField;
126  typedef typename BasicTurbulenceModel::transportModel transportModel;
127 
128 
129  //- Runtime type information
130  TypeName("LaheyKEpsilon");
131 
132 
133  // Constructors
134 
135  //- Construct from components
137  (
138  const alphaField& alpha,
139  const rhoField& rho,
140  const volVectorField& U,
141  const surfaceScalarField& alphaRhoPhi,
142  const surfaceScalarField& phi,
143  const transportModel& transport,
144  const word& propertiesName = turbulenceModel::propertiesName,
145  const word& type = typeName
146  );
147 
148 
149  //- Destructor
150  virtual ~LaheyKEpsilon()
151  {}
152 
153 
154  // Member Functions
155 
156  //- Read model coefficients if they have changed
157  virtual bool read();
158 
159  //- Solve the turbulence equations and correct the turbulence viscosity
160  virtual void correct();
161 };
162 
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 } // End namespace RASModels
167 } // End namespace Foam
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 #ifdef NoRepository
172  #include "LaheyKEpsilon.C"
173 #endif
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #endif
178 
179 // ************************************************************************* //
TypeName("LaheyKEpsilon")
Runtime type information.
BasicTurbulenceModel::rhoField rhoField
surfaceScalarField & phi
dimensionedScalar alphaInversion_
virtual bool read()
Read model coefficients if they have changed.
virtual void correct()
Solve the turbulence equations and correct the turbulence viscosity.
Continuous-phase k-epsilon model including bubble-generated turbulence.
Definition: LaheyKEpsilon.H:74
BasicTurbulenceModel::alphaField alphaField
Standard k-epsilon turbulence model for incompressible and compressible flows including rapid distort...
Definition: kEpsilon.H:83
static const word propertiesName
Default name of the turbulence properties dictionary.
A class for handling words, derived from string.
Definition: word.H:59
BasicTurbulenceModel::transportModel transportModel
Templated abstract base class for multiphase compressible turbulence models.
tmp< volScalarField > phaseTransferCoeff() const
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:481
virtual ~LaheyKEpsilon()
Destructor.
virtual tmp< fvScalarMatrix > kSource() const
U
Definition: pEqn.H:72
tmp< volScalarField > bubbleG() const
virtual tmp< fvScalarMatrix > epsilonSource() const
A class for managing temporary objects.
Definition: PtrList.H:53
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
Namespace for OpenFOAM.