LaheyKEpsilon.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) 2013-2016 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 
27 Class
28  Foam::RASModels::LaheyKEpsilon
29 
30 Group
31  grpRASTurbulence
32 
33 Description
34  Continuous-phase k-epsilon model including bubble-generated turbulence.
35 
36  Reference:
37  \verbatim
38  Lahey Jr, R. T. (2005).
39  The simulation of multidimensional multiphase flows.
40  Nuclear Engineering and Design, 235(10), 1043-1060.
41  \endverbatim
42 
43  The default model coefficients are
44  \verbatim
45  LaheyKEpsilonCoeffs
46  {
47  Cmu 0.09;
48  C1 1.44;
49  C2 1.92;
50  C3 -0.33;
51  sigmak 1.0;
52  sigmaEps 1.3;
53  Cp 0.25;
54  Cmub 0.6;
55  alphaInversion 0.3;
56  }
57  \endverbatim
58 
59 SourceFiles
60  LaheyKEpsilon.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef LaheyKEpsilon_H
65 #define LaheyKEpsilon_H
66 
67 #include "kEpsilon.H"
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 namespace RASModels
74 {
75 
76 /*---------------------------------------------------------------------------*\
77  Class LaheyKEpsilon Declaration
78 \*---------------------------------------------------------------------------*/
79 
80 template<class BasicTurbulenceModel>
81 class LaheyKEpsilon
82 :
83  public kEpsilon<BasicTurbulenceModel>
84 {
85  // Private data
86 
88  <
89  typename BasicTurbulenceModel::transportModel
90  > *gasTurbulencePtr_;
91 
92 
93  // Private Member Functions
94 
95  //- Return the turbulence model for the gas phase
97  <
98  typename BasicTurbulenceModel::transportModel
99  >&
100  gasTurbulence() const;
101 
102  //- No copy construct
103  LaheyKEpsilon(const LaheyKEpsilon&) = delete;
104 
105  //- No copy assignment
106  void operator=(const LaheyKEpsilon&) = delete;
107 
108 
109 protected:
110 
111  // Protected data
112 
113  // Model coefficients
114 
119 
120 
121  // Protected Member Functions
122 
123  virtual void correctNut();
126  virtual tmp<fvScalarMatrix> kSource() const;
127  virtual tmp<fvScalarMatrix> epsilonSource() const;
128 
129 
130 public:
131 
132  typedef typename BasicTurbulenceModel::alphaField alphaField;
133  typedef typename BasicTurbulenceModel::rhoField rhoField;
134  typedef typename BasicTurbulenceModel::transportModel transportModel;
135 
136 
137  //- Runtime type information
138  TypeName("LaheyKEpsilon");
139 
140 
141  // Constructors
142 
143  //- Construct from components
145  (
146  const alphaField& alpha,
147  const rhoField& rho,
148  const volVectorField& U,
149  const surfaceScalarField& alphaRhoPhi,
150  const surfaceScalarField& phi,
151  const transportModel& transport,
152  const word& propertiesName = turbulenceModel::propertiesName,
153  const word& type = typeName
154  );
155 
156 
157  //- Destructor
158  virtual ~LaheyKEpsilon() = default;
159 
160 
161  // Member Functions
162 
163  //- Read model coefficients if they have changed
164  virtual bool read();
165 
166  //- Solve the turbulence equations and correct the turbulence viscosity
167  virtual void correct();
168 };
169 
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 } // End namespace RASModels
174 } // End namespace Foam
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #ifdef NoRepository
179  #include "LaheyKEpsilon.C"
180 #endif
181 
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 
184 #endif
185 
186 // ************************************************************************* //
Foam::RASModels::LaheyKEpsilon::transportModel
BasicTurbulenceModel::transportModel transportModel
Definition: LaheyKEpsilon.H:133
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::RASModels::LaheyKEpsilon::phaseTransferCoeff
tmp< volScalarField > phaseTransferCoeff() const
Definition: LaheyKEpsilon.C:218
Foam::PhaseCompressibleTurbulenceModel
Templated abstract base class for multiphase compressible turbulence models.
Definition: phaseCompressibleTurbulenceModelFwd.H:44
Foam::tmp< volScalarField >
Foam::constant::atomic::alpha
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
Definition: readThermalProperties.H:212
Foam::turbulenceModel::propertiesName
static const word propertiesName
Default name of the turbulence properties dictionary.
Definition: turbulenceModel.H:100
Foam::RASModels::LaheyKEpsilon::bubbleG
tmp< volScalarField > bubbleG() const
Definition: LaheyKEpsilon.C:187
Foam::RASModels::LaheyKEpsilon::kSource
virtual tmp< fvScalarMatrix > kSource() const
Definition: LaheyKEpsilon.C:236
Foam::RASModels::LaheyKEpsilon::correctNut
virtual void correctNut()
Definition: LaheyKEpsilon.C:169
rho
rho
Definition: readInitialConditions.H:88
Foam::RASModels::LaheyKEpsilon::C3_
dimensionedScalar C3_
Definition: LaheyKEpsilon.H:116
Foam::RASModels::LaheyKEpsilon::epsilonSource
virtual tmp< fvScalarMatrix > epsilonSource() const
Definition: LaheyKEpsilon.C:254
LaheyKEpsilon.C
Foam::RASModels::LaheyKEpsilon::~LaheyKEpsilon
virtual ~LaheyKEpsilon()=default
Destructor.
Foam::RASModels::LaheyKEpsilon::Cmub_
dimensionedScalar Cmub_
Definition: LaheyKEpsilon.H:117
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::RASModels::LaheyKEpsilon
Continuous-phase k-epsilon model including bubble-generated turbulence.
Definition: LaheyKEpsilon.H:80
Foam::RASModels::LaheyKEpsilon::rhoField
BasicTurbulenceModel::rhoField rhoField
Definition: LaheyKEpsilon.H:132
Foam::RASModels::LaheyKEpsilon::TypeName
TypeName("LaheyKEpsilon")
Runtime type information.
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::RASModels::LaheyKEpsilon::alphaInversion_
dimensionedScalar alphaInversion_
Definition: LaheyKEpsilon.H:114
Foam::RASModels::LaheyKEpsilon::correct
virtual void correct()
Solve the turbulence equations and correct the turbulence viscosity.
Definition: LaheyKEpsilon.C:272
U
U
Definition: pEqn.H:72
Foam::RASModels::LaheyKEpsilon::read
virtual bool read()
Read model coefficients if they have changed.
Definition: LaheyKEpsilon.C:120
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::RASModels::LaheyKEpsilon::Cp_
dimensionedScalar Cp_
Definition: LaheyKEpsilon.H:115
Foam::GeometricField< vector, fvPatchField, volMesh >
Foam::RASModels::kEpsilon
Standard k-epsilon turbulence model for incompressible and compressible flows including rapid distort...
Definition: kEpsilon.H:89
Foam::RASModels::LaheyKEpsilon::alphaField
BasicTurbulenceModel::alphaField alphaField
Definition: LaheyKEpsilon.H:131