PhaseCompressibleTurbulenceModel.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 | Copyright (C) 2013-2015 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::PhaseCompressibleTurbulenceModel
26 
27 Description
28  Templated abstract base class for multiphase compressible
29  turbulence models.
30 
31 SourceFiles
32  PhaseCompressibleTurbulenceModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef PhaseCompressibleTurbulenceModel_H
37 #define PhaseCompressibleTurbulenceModel_H
38 
39 #include "TurbulenceModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class PhaseCompressibleTurbulenceModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class TransportModel>
53 :
54  public TurbulenceModel
55  <
56  volScalarField,
57  volScalarField,
58  compressibleTurbulenceModel,
59  TransportModel
60  >
61 {
62 
63 public:
64 
67  typedef TransportModel transportModel;
68 
69 
70  // Constructors
71 
72  //- Construct
74  (
75  const word& type,
76  const alphaField& alpha,
77  const volScalarField& rho,
78  const volVectorField& U,
79  const surfaceScalarField& alphaRhoPhi,
80  const surfaceScalarField& phi,
81  const transportModel& trasport,
82  const word& propertiesName
83  );
84 
85 
86  // Selectors
87 
88  //- Return a reference to the selected turbulence model
90  (
91  const alphaField& alpha,
92  const volScalarField& rho,
93  const volVectorField& U,
94  const surfaceScalarField& alphaRhoPhi,
95  const surfaceScalarField& phi,
96  const transportModel& trasportModel,
97  const word& propertiesName = turbulenceModel::propertiesName
98  );
99 
100 
101  //- Destructor
103  {}
104 
105 
106  // Member Functions
107 
108  //- Return the laminar dynamic viscosity
109  virtual tmp<volScalarField> mu() const
110  {
111  return this->transport_.mu();
112  }
113 
114  //- Return the laminar dynamic viscosity on patch
115  virtual tmp<scalarField> mu(const label patchi) const
116  {
117  return this->transport_.mu(patchi);
118  }
119 
120  //- Return the turbulence dynamic viscosity
121  virtual tmp<volScalarField> mut() const
122  {
123  return this->rho_*this->nut();
124  }
125 
126  //- Return the turbulence dynamic viscosity on patch
127  virtual tmp<scalarField> mut(const label patchi) const
128  {
129  return this->rho_.boundaryField()[patchi]*this->nut(patchi);
130  }
131 
132  //- Return the effective dynamic viscosity
133  virtual tmp<volScalarField> muEff() const
134  {
135  return mut() + mu();
136  }
137 
138  //- Return the effective dynamic viscosity on patch
139  virtual tmp<scalarField> muEff(const label patchi) const
140  {
141  return mut(patchi) + mu(patchi);
142  }
143 
144  //- Return the phase-pressure'
145  // (derivative of phase-pressure w.r.t. phase-fraction)
146  virtual tmp<volScalarField> pPrime() const;
147 
148  //- Return the face-phase-pressure'
149  // (derivative of phase-pressure w.r.t. phase-fraction)
150  virtual tmp<surfaceScalarField> pPrimef() const;
151 };
152 
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 } // End namespace Foam
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #ifdef NoRepository
162 #endif
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #endif
167 
168 // ************************************************************************* //
A class for handling words, derived from string.
Definition: word.H:59
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
PhaseCompressibleTurbulenceModel(const word &type, const alphaField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &trasport, const word &propertiesName)
Construct.
Namespace for OpenFOAM.
Templated abstract base class for turbulence models.
scalar nut
virtual tmp< surfaceScalarField > pPrimef() const
Return the face-phase-pressure&#39;.
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
virtual tmp< volScalarField > mut() const
Return the turbulence dynamic viscosity.
label patchi
virtual tmp< volScalarField > muEff() const
Return the effective dynamic viscosity.
Templated abstract base class for multiphase compressible turbulence models.
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:589
surfaceScalarField & phi
virtual tmp< volScalarField > mu() const
Return the laminar dynamic viscosity.
static const word propertiesName
Default name of the turbulence properties dictionary.
virtual tmp< volScalarField > pPrime() const
Return the phase-pressure&#39;.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
static autoPtr< PhaseCompressibleTurbulenceModel > New(const alphaField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &trasportModel, const word &propertiesName=turbulenceModel::propertiesName)
Return a reference to the selected turbulence model.
U
Definition: pEqn.H:82