compressibleTurbulenceModel.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2013-2015 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::compressibleTurbulenceModel
29 
30 Description
31  Abstract base class for turbulence models (RAS, LES and laminar).
32 
33 SourceFiles
34  compressibleTurbulenceModel.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef compressibleTurbulenceModel_H
39 #define compressibleTurbulenceModel_H
40 
41 #include "turbulenceModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declarations
49 class fvMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class compressibleTurbulenceModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public turbulenceModel
58 {
59 
60 protected:
61 
62  // Protected data
63 
64  const volScalarField& rho_;
65 
66 
67  // Protected member functions
68 
69  //- ***HGW Temporary function to be removed when the run-time selectable
70  // thermal transport layer is complete
71  virtual void correctNut()
72  {}
73 
74 
75 private:
76 
77  // Private Member Functions
78 
79  //- No copy construct
81  (
83  ) = delete;
84 
85  //- No copy assignment
86  void operator=(const compressibleTurbulenceModel&) = delete;
87 
88 
89 public:
90 
91  //- Runtime type information
92  TypeName("compressibleTurbulenceModel");
93 
94 
95  // Constructors
96 
97  //- Construct from components
99  (
100  const volScalarField& rho,
101  const volVectorField& U,
103  const surfaceScalarField& phi,
104  const word& propertiesName
105  );
106 
107 
108  //- Destructor
109  virtual ~compressibleTurbulenceModel() = default;
110 
111 
112  // Member functions
113 
114  //- Return the density field
115  const volScalarField& rho() const
116  {
117  return rho_;
118  }
119 
120  //- Return the volumetric flux field
121  virtual tmp<surfaceScalarField> phi() const;
122 
123  //- Return the effective stress tensor including the laminar stress
124  virtual tmp<volSymmTensorField> devRhoReff() const = 0;
125 
126  //- Return the source term for the momentum equation
128 
129  //- Correct the turbulence thermal diffusivity for energy transport
130  virtual void correctEnergyTransport();
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::compressibleTurbulenceModel::correctNut
virtual void correctNut()
***HGW Temporary function to be removed when the run-time selectable
Definition: compressibleTurbulenceModel.H:70
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::turbulenceModel::propertiesName
static const word propertiesName
Default name of the turbulence properties dictionary.
Definition: turbulenceModel.H:100
Foam::compressibleTurbulenceModel::devRhoReff
virtual tmp< volSymmTensorField > devRhoReff() const =0
Return the effective stress tensor including the laminar stress.
Foam::turbulenceModel::alphaRhoPhi
const surfaceScalarField & alphaRhoPhi() const
Access function to phase flux field.
Definition: turbulenceModel.H:150
Foam::compressibleTurbulenceModel::~compressibleTurbulenceModel
virtual ~compressibleTurbulenceModel()=default
Destructor.
Foam::compressibleTurbulenceModel::rho_
const volScalarField & rho_
Definition: compressibleTurbulenceModel.H:63
Foam::compressibleTurbulenceModel::rho
const volScalarField & rho() const
Return the density field.
Definition: compressibleTurbulenceModel.H:114
Foam::turbulenceModel
Abstract base class for turbulence models (RAS, LES and laminar).
Definition: turbulenceModel.H:63
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::compressibleTurbulenceModel::divDevRhoReff
virtual tmp< fvVectorMatrix > divDevRhoReff(volVectorField &U) const =0
Return the source term for the momentum equation.
Foam::compressibleTurbulenceModel::phi
virtual tmp< surfaceScalarField > phi() const
Return the volumetric flux field.
Definition: compressibleTurbulenceModel.C:65
Foam::compressibleTurbulenceModel::correctEnergyTransport
virtual void correctEnergyTransport()
Correct the turbulence thermal diffusivity for energy transport.
Definition: compressibleTurbulenceModel.C:78
Foam::compressibleTurbulenceModel::TypeName
TypeName("compressibleTurbulenceModel")
Runtime type information.
Foam::GeometricField< scalar, fvPatchField, volMesh >
turbulenceModel.H
Foam::compressibleTurbulenceModel
Abstract base class for turbulence models (RAS, LES and laminar).
Definition: compressibleTurbulenceModel.H:54
Foam::turbulenceModel::U
const volVectorField & U() const
Access function to velocity field.
Definition: turbulenceModel.H:144