PhaseIncompressibleTurbulenceModel.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-2016 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::PhaseIncompressibleTurbulenceModel
26 
27 Description
28  Templated abstract base class for multiphase incompressible
29  turbulence models.
30 
31 SourceFiles
32  PhaseIncompressibleTurbulenceModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef PhaseIncompressibleTurbulenceModel_H
37 #define PhaseIncompressibleTurbulenceModel_H
38 
39 #include "TurbulenceModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class PhaseIncompressibleTurbulenceModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class TransportModel>
53 :
54  public TurbulenceModel
55  <
56  volScalarField,
57  geometricOneField,
58  incompressibleTurbulenceModel,
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 geometricOneField& rho,
78  const volVectorField& U,
80  const surfaceScalarField& phi,
81  const TransportModel& trasportModel,
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 volVectorField& U,
94  const surfaceScalarField& phi,
95  const TransportModel& trasportModel,
97  );
98 
99 
100  //- Destructor
102  {}
103 
104 
105  // Member Functions
106 
107  //- Return the phase-pressure'
108  // (derivative of phase-pressure w.r.t. phase-fraction)
109  virtual tmp<volScalarField> pPrime() const;
110 
111  //- Return the face-phase-pressure'
112  // (derivative of phase-pressure w.r.t. phase-fraction)
113  virtual tmp<surfaceScalarField> pPrimef() const;
114 
115  //- Return the effective stress tensor
116  virtual tmp<volSymmTensorField> devReff() const;
117 
118  //- Return the source term for the momentum equation
120 
121  //- Return the effective stress tensor
122  virtual tmp<volSymmTensorField> devRhoReff() const;
123 
124  //- Return the source term for the momentum equation
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #ifdef NoRepository
137 #endif
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
virtual tmp< volScalarField > pPrime() const
Return the phase-pressure&#39;.
Templated abstract base class for turbulence models.
const volVectorField & U() const
Access function to velocity field.
static autoPtr< PhaseIncompressibleTurbulenceModel > New(const alphaField &alpha, 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.
Templated abstract base class for multiphase incompressible turbulence models.
virtual tmp< surfaceScalarField > phi() const
Return the volumetric flux field.
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
virtual tmp< fvVectorMatrix > divDevReff(volVectorField &U) const
Return the source term for the momentum equation.
const surfaceScalarField & alphaRhoPhi() const
Access function to phase flux field.
static const word propertiesName
Default name of the turbulence properties dictionary.
A class for handling words, derived from string.
Definition: word.H:59
PhaseIncompressibleTurbulenceModel(const word &type, const alphaField &alpha, const geometricOneField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const TransportModel &trasportModel, const word &propertiesName)
Construct.
virtual tmp< fvVectorMatrix > divDevRhoReff(volVectorField &U) const
Return the source term for the momentum equation.
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:461
virtual tmp< volSymmTensorField > devRhoReff() const
Return the effective stress tensor.
virtual tmp< volSymmTensorField > devReff() const
Return the effective stress tensor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
A class for managing temporary objects.
Definition: PtrList.H:54
virtual tmp< surfaceScalarField > pPrimef() const
Return the face-phase-pressure&#39;.
Namespace for OpenFOAM.