compressibleTurbulenceModel.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) 2013-2018 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::compressibleTurbulenceModel
26 
27 Description
28  Abstract base class for turbulence models (RAS, LES and laminar).
29 
30 SourceFiles
31  compressibleTurbulenceModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef compressibleTurbulenceModel_H
36 #define compressibleTurbulenceModel_H
37 
38 #include "turbulenceModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declarations
46 class fvMesh;
47 
48 /*---------------------------------------------------------------------------*\
49  Class compressibleTurbulenceModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public turbulenceModel
55 {
56 
57 protected:
58 
59  // Protected data
60 
61  const volScalarField& rho_;
62 
63 
64  // Protected member functions
65 
66  //- ***HGW Temporary function to be removed when the run-time selectable
67  // thermal transport layer is complete
68  virtual void correctNut()
69  {}
70 
71 
72 private:
73 
74  // Private Member Functions
75 
76  //- Disallow default bitwise copy construct
78 
79  //- Disallow default bitwise assignment
80  void operator=(const compressibleTurbulenceModel&);
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("compressibleTurbulenceModel");
87 
88 
89  // Constructors
90 
91  //- Construct from components
93  (
94  const volScalarField& rho,
95  const volVectorField& U,
97  const surfaceScalarField& phi,
98  const word& propertiesName
99  );
100 
101 
102  //- Destructor
104  {}
105 
106 
107  // Member functions
108 
109  //- Return the density field
110  const volScalarField& rho() const
111  {
112  return rho_;
113  }
114 
115  //- Return the volumetric flux field
116  virtual tmp<surfaceScalarField> phi() const;
117 
118  //- Return the effective stress tensor including the laminar stress
119  virtual tmp<volSymmTensorField> devRhoReff() const = 0;
120 
121  //- Return the source term for the momentum equation
122  virtual tmp<fvVectorMatrix> divDevRhoReff(volVectorField& U) const = 0;
123 
124  //- Correct the turbulence thermal diffusivity for energy transport
125  virtual void correctEnergyTransport();
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
const volVectorField & U() const
Access function to velocity field.
virtual void correctNut()
***HGW Temporary function to be removed when the run-time selectable
Abstract base class for turbulence models (RAS, LES and laminar).
virtual tmp< volSymmTensorField > devRhoReff() const =0
Return the effective stress tensor including the laminar stress.
static const word propertiesName
Default name of the turbulence properties dictionary.
A class for handling words, derived from string.
Definition: word.H:59
const surfaceScalarField & alphaRhoPhi() const
Access function to phase flux field.
virtual tmp< fvVectorMatrix > divDevRhoReff(volVectorField &U) const =0
Return the source term for the momentum equation.
const volScalarField & rho() const
Return the density field.
Abstract base class for turbulence models (RAS, LES and laminar).
virtual tmp< surfaceScalarField > phi() const
Return the volumetric flux field.
virtual void correctEnergyTransport()
Correct the turbulence thermal diffusivity for energy transport.
A class for managing temporary objects.
Definition: PtrList.H:53
TypeName("compressibleTurbulenceModel")
Runtime type information.
Namespace for OpenFOAM.