NicenoKEqn.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::LESModels::NicenoKEqn
26 
27 Description
28  One-equation SGS model for the continuous phase in a two-phase system
29  including bubble-generated turbulence.
30 
31  Reference:
32  \verbatim
33  Niceno, B., Dhotre, M. T., & Deen, N. G. (2008).
34  One-equation sub-grid scale (SGS) modelling for
35  Euler–Euler large eddy simulation (EELES) of dispersed bubbly flow.
36  Chemical Engineering Science, 63(15), 3923-3931.
37  \endverbatim
38 
39  The default model coefficients are:
40  \verbatim
41  NicenoKEqnCoeffs
42  {
43  Ck 0.094;
44  Ce 1.048;
45  alphaInversion 0.3;
46  Cp Ck;
47  Cmub 0.6;
48  }
49  \endverbatim
50 
51 SourceFiles
52  NicenoKEqn.C
53 
54 \*---------------------------------------------------------------------------*/
55 
56 #ifndef NicenoKEqn_H
57 #define NicenoKEqn_H
58 
59 #include "kEqn.H"
60 
61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 
63 namespace Foam
64 {
65 namespace LESModels
66 {
67 
68 /*---------------------------------------------------------------------------*\
69  Class NicenoKEqn Declaration
70 \*---------------------------------------------------------------------------*/
71 
72 template<class BasicTurbulenceModel>
73 class NicenoKEqn
74 :
75  public kEqn<BasicTurbulenceModel>
76 {
77  // Private data
78 
80  <
81  typename BasicTurbulenceModel::transportModel
82  > *gasTurbulencePtr_;
83 
84 
85  // Private Member Functions
86 
87  //- Return the turbulence model for the gas phase
89  <
90  typename BasicTurbulenceModel::transportModel
91  >&
92  gasTurbulence() const;
93 
94  // Disallow default bitwise copy construct and assignment
95  NicenoKEqn(const NicenoKEqn&);
96  void operator=(const NicenoKEqn&);
97 
98 
99 protected:
100 
101  // Protected data
102 
103  // Model coefficients
108 
109 
110  // Protected Member Functions
111 
112  virtual void correctNut();
115  virtual tmp<fvScalarMatrix> kSource() const;
116 
117 
118 public:
120  typedef typename BasicTurbulenceModel::alphaField alphaField;
121  typedef typename BasicTurbulenceModel::rhoField rhoField;
122  typedef typename BasicTurbulenceModel::transportModel transportModel;
123 
124 
125  //- Runtime type information
126  TypeName("NicenoKEqn");
127 
128 
129  // Constructors
130 
131  //- Construct from components
132  NicenoKEqn
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& propertiesName = turbulenceModel::propertiesName,
141  const word& type = typeName
142  );
143 
144 
145  //- Destructor
146  virtual ~NicenoKEqn()
147  {}
148 
149 
150  // Member Functions
151 
152  //- Read model coefficients if they have changed
153  virtual bool read();
154 };
155 
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 } // End namespace LESModels
160 } // End namespace Foam
161 
162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
163 
164 #ifdef NoRepository
165  #include "NicenoKEqn.C"
166 #endif
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 #endif
171 
172 // ************************************************************************* //
BasicTurbulenceModel::alphaField alphaField
Definition: NicenoKEqn.H:119
surfaceScalarField & phi
dimensionedScalar Cmub_
Definition: NicenoKEqn.H:106
dimensionedScalar Cp_
Definition: NicenoKEqn.H:105
BasicTurbulenceModel::rhoField rhoField
Definition: NicenoKEqn.H:120
One equation eddy-viscosity model.
Definition: kEqn.H:71
virtual ~NicenoKEqn()
Destructor.
Definition: NicenoKEqn.H:145
static const word propertiesName
Default name of the turbulence properties dictionary.
virtual bool read()
Read model coefficients if they have changed.
Definition: NicenoKEqn.C:107
A class for handling words, derived from string.
Definition: word.H:59
tmp< volScalarField > bubbleG() const
Definition: NicenoKEqn.C:175
tmp< volScalarField > phaseTransferCoeff() const
Definition: NicenoKEqn.C:200
virtual tmp< fvScalarMatrix > kSource() const
Definition: NicenoKEqn.C:222
Templated abstract base class for multiphase compressible turbulence models.
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:481
U
Definition: pEqn.H:72
One-equation SGS model for the continuous phase in a two-phase system including bubble-generated turb...
Definition: NicenoKEqn.H:72
TypeName("NicenoKEqn")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
BasicTurbulenceModel::transportModel transportModel
Definition: NicenoKEqn.H:121
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
virtual void correctNut()
Definition: NicenoKEqn.C:157
Namespace for OpenFOAM.
dimensionedScalar alphaInversion_
Definition: NicenoKEqn.H:104