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