IncompressibleTurbulenceModel.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::IncompressibleTurbulenceModel
26 
27 Description
28  Templated abstract base class for single-phase incompressible
29  turbulence models.
30 
31 SourceFiles
32  IncompressibleTurbulenceModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef IncompressibleTurbulenceModel_H
37 #define IncompressibleTurbulenceModel_H
38 
39 #include "TurbulenceModel.H"
41 #include "fvMatrix.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class IncompressibleTurbulenceModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class TransportModel>
54 :
55  public TurbulenceModel
56  <
57  geometricOneField,
58  geometricOneField,
59  incompressibleTurbulenceModel,
60  TransportModel
61  >
62 {
63 
64 public:
65 
68  typedef TransportModel transportModel;
69 
70 
71  // Constructors
72 
73  //- Construct
75  (
76  const word& type,
77  const geometricOneField& alpha,
78  const geometricOneField& rho,
79  const volVectorField& U,
81  const surfaceScalarField& phi,
82  const TransportModel& transport,
83  const word& propertiesName
84  );
85 
86 
87  // Selectors
88 
89  //- Return a reference to the selected turbulence model
91  (
92  const volVectorField& U,
93  const surfaceScalarField& phi,
94  const TransportModel& trasportModel,
96  );
97 
98 
99  //- Destructor
101  {}
102 
103 
104  // Member Functions
105 
106  //- Return the effective stress tensor
107  virtual tmp<volSymmTensorField> devReff() const;
108 
109  //- Return the source term for the momentum equation
111 
112  //- Return the effective stress tensor
113  virtual tmp<volSymmTensorField> devRhoReff() const;
114 
115  //- Return the source term for the momentum equation
117 
118  //- Return the source term for the momentum equation
120  (
121  const volScalarField& rho,
122  volVectorField& U
123  ) const;
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #ifdef NoRepository
135 #endif
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
const volVectorField & U() const
Access function to velocity field.
IncompressibleTurbulenceModel(const word &type, const geometricOneField &alpha, const geometricOneField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const TransportModel &transport, const word &propertiesName)
Construct.
Templated abstract base class for turbulence models.
const transportModel & transport() const
Access function to incompressible transport model.
virtual tmp< surfaceScalarField > phi() const
Return the volumetric flux field.
Templated abstract base class for single-phase incompressible turbulence models.
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
static const word propertiesName
Default name of the turbulence properties dictionary.
A class for handling words, derived from string.
Definition: word.H:59
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.
virtual tmp< fvVectorMatrix > divDevRhoReff(volVectorField &U) const
Return the source term for the momentum equation.
virtual tmp< volSymmTensorField > devReff() const
Return the effective stress tensor.
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:485
virtual tmp< volSymmTensorField > devRhoReff() const
Return the effective stress tensor.
static autoPtr< IncompressibleTurbulenceModel > New(const volVectorField &U, const surfaceScalarField &phi, const TransportModel &trasportModel, const word &propertiesName=turbulenceModel::propertiesName)
Return a reference to the selected turbulence model.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.