kineticTheoryModel.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) 2011-2023 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::kineticTheoryModel
26 
27 Description
28  Kinetic theory particle phase RAS model
29 
30  Reference:
31  \verbatim
32  van Wachem, B. G. M. (2000).
33  Derivation, implementation, and validation of computer simulation models
34  for gas-solid fluidised beds.
35  PhD Thesis, TU Delft.
36  \endverbatim
37 
38  There are no default model coefficients.
39 
40 SourceFiles
41  kineticTheoryModel.C
42 
43 \*---------------------------------------------------------------------------*/
44 
45 #ifndef kineticTheoryModel_H
46 #define kineticTheoryModel_H
47 
48 #include "RASModel.H"
49 #include "eddyViscosity.H"
51 #include "phaseModel.H"
52 #include "dragModel.H"
54 #include "conductivityModel.H"
55 #include "radialModel.H"
56 #include "granularPressureModel.H"
57 #include "frictionalStressModel.H"
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 namespace Foam
62 {
63 namespace RASModels
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class kineticTheoryModel Declaration
68 \*---------------------------------------------------------------------------*/
69 
71 :
72  public eddyViscosity<RASModel<phaseCompressible::momentumTransportModel>>
73 {
74  // Private Data
75 
76  const phaseModel& phase_;
77 
78  //- Name of the continuous phase
79  word continuousPhaseName_;
80 
81 
82  // Sub-models
83 
84  //- Run-time selected viscosity model
86 
87  //- Run-time selected conductivity model
89 
90  //- Run-time selected radial distribution model
92 
93  //- Run-time selected granular pressure model
95  granularPressureModel_;
96 
97  //- Run-time selected frictional stress model
99  frictionalStressModel_;
100 
101 
102  // Kinetic Theory Model coefficients
103 
104  //- Use equilibrium approximation: generation == dissipation
105  Switch equilibrium_;
106 
107  //- Coefficient of restitution
109 
110  //- Min value for which the frictional stresses are zero
111  dimensionedScalar alphaMinFriction_;
112 
113  //- Residual phase fraction
114  dimensionedScalar residualAlpha_;
115 
116  //- Maximum turbulent viscosity
117  dimensionedScalar maxNut_;
118 
119 
120  // Kinetic Theory Model Fields
121 
122  //- The granular energy/temperature
123  volScalarField Theta_;
124 
125  //- The granular bulk viscosity
126  volScalarField lambda_;
127 
128  //- The granular radial distribution
129  volScalarField gs0_;
130 
131  //- The granular "thermal" conductivity
132  volScalarField kappa_;
133 
134  //- The frictional viscosity
135  volScalarField nuFric_;
136 
137 
138  // Private Member Functions
139 
140  void correctNut()
141  {}
142 
143  //- Return the continuous phase model
144  // which for two-phases is the "other" phase
145  // and for more than two phases must be specified
146  const phaseModel& continuousPhase() const;
147 
148 
149 public:
150 
151  //- Runtime type information
152  TypeName("kineticTheory");
153 
154 
155  // Constructors
156 
157  //- Construct from components
159  (
160  const volScalarField& alpha,
161  const volScalarField& rho,
162  const volVectorField& U,
163  const surfaceScalarField& alphaRhoPhi,
164  const surfaceScalarField& phi,
165  const viscosity& viscosity,
166  const word& type = typeName
167  );
168 
169  //- Disallow default bitwise copy construction
170  kineticTheoryModel(const kineticTheoryModel&) = delete;
171 
172 
173  //- Destructor
174  virtual ~kineticTheoryModel();
175 
176 
177  // Member Functions
178 
179  //- Re-read model coefficients if they have changed
180  virtual bool read();
181 
182  //- Return the effective viscosity
183  virtual tmp<volScalarField> nuEff() const
184  {
185  return this->nut();
186  }
187 
188  //- Return the effective viscosity on patch
189  virtual tmp<scalarField> nuEff(const label patchi) const
190  {
191  return this->nut(patchi);
192  }
193 
194  //- Return the turbulence kinetic energy
195  virtual tmp<volScalarField> k() const;
196 
197  //- Return the turbulence kinetic energy dissipation rate
198  virtual tmp<volScalarField> epsilon() const;
199 
200  //- Return the turbulence specific dissipation rate
201  virtual tmp<volScalarField> omega() const;
202 
203  //- Return the stress tensor [m^2/s^2]
204  virtual tmp<volSymmTensorField> sigma() const;
205 
206  //- Return the phase-pressure'
207  // (derivative of phase-pressure w.r.t. phase-fraction)
208  virtual tmp<volScalarField> pPrime() const;
209 
210  //- Return the face-phase-pressure'
211  // (derivative of phase-pressure w.r.t. phase-fraction)
212  virtual tmp<surfaceScalarField> pPrimef() const;
213 
214  //- Return the effective stress tensor
215  virtual tmp<volSymmTensorField> devTau() const;
216 
217  //- Return the source term for the momentum equation
219 
220  //- Solve the kinetic theory equations and correct the viscosity
221  virtual void correct();
222 
223 
224  // Member Operators
225 
226  //- Disallow default bitwise assignment
227  void operator=(const kineticTheoryModel&) = delete;
228 };
229 
230 
231 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
232 
233 } // End namespace RASModels
234 } // End namespace Foam
235 
236 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
237 
238 #endif
239 
240 // ************************************************************************* //
Generic GeometricField class.
Kinetic theory particle phase RAS model.
virtual tmp< volScalarField > epsilon() const
Return the turbulence kinetic energy dissipation rate.
virtual tmp< volScalarField > nuEff() const
Return the effective viscosity.
virtual void correct()
Solve the kinetic theory equations and correct the viscosity.
virtual tmp< volScalarField > k() const
Return the turbulence kinetic energy.
virtual tmp< volSymmTensorField > devTau() const
Return the effective stress tensor.
virtual tmp< volScalarField > pPrime() const
Return the phase-pressure'.
virtual tmp< surfaceScalarField > pPrimef() const
Return the face-phase-pressure'.
void operator=(const kineticTheoryModel &)=delete
Disallow default bitwise assignment.
virtual tmp< fvVectorMatrix > divDevTau(volVectorField &U) const
Return the source term for the momentum equation.
virtual tmp< volSymmTensorField > sigma() const
Return the stress tensor [m^2/s^2].
kineticTheoryModel(const volScalarField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity, const word &type=typeName)
Construct from components.
virtual tmp< volScalarField > omega() const
Return the turbulence specific dissipation rate.
TypeName("kineticTheory")
Runtime type information.
virtual bool read()
Re-read model coefficients if they have changed.
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:61
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Eddy viscosity turbulence model base class.
Definition: eddyViscosity.H:52
virtual tmp< volScalarField > nut() const
Return the turbulence viscosity.
A class for managing temporary objects.
Definition: tmp.H:55
Abstract base class for all fluid physical properties.
Definition: viscosity.H:50
A class for handling words, derived from string.
Definition: word.H:62
label patchi
U
Definition: pEqn.H:72
volScalarField alpha(IOobject("alpha", runTime.name(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488