src/turbulenceModels/compressible/turbulenceModel/turbulenceModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
   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 Namespace
  25     Foam::compressible::turbulenceModels
  26
  27 Description
  28     Namespace for compressible turbulence turbulence models.
  29
  30
  31 Class
  32     Foam::compressible::turbulenceModel
  33
  34 Description
  35     Abstract base class for compressible turbulence models
  36     (RAS, LES and laminar).
  37
  38
  39 SourceFiles
  40     turbulenceModel.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef compressibleturbulenceModel_H
  45 #define compressibleturbulenceModel_H
  46
  47 #include "primitiveFieldsFwd.H"
  48 #include "volFieldsFwd.H"
  49 #include "surfaceFieldsFwd.H"
  50 #include "fvMatricesFwd.H"
  51 #include "basicThermo.H"
  52 #include "autoPtr.H"
  53 #include "runTimeSelectionTables.H"
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 namespace Foam
  58 {
  59
  60 // Forward declarations
  61 class fvMesh;
  62
  63 namespace compressible
  64 {
  65
  66 /*---------------------------------------------------------------------------*\
  67                        Class turbulenceModel Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class turbulenceModel
  71 :
  72     public regIOobject
  73 {
  74
  75 protected:
  76
  77     // Protected data
  78
  79         const Time& runTime_;
  80         const fvMesh& mesh_;
  81
  82         const volScalarField& rho_;
  83         const volVectorField& U_;
  84         const surfaceScalarField& phi_;
  85
  86         const basicThermo& thermophysicalModel_;
  87
  88
  89 private:
  90
  91     // Private Member Functions
  92
  93         //- Disallow default bitwise copy construct
  94         turbulenceModel(const turbulenceModel&);
  95
  96         //- Disallow default bitwise assignment
  97         void operator=(const turbulenceModel&);
  98
  99
 100 public:
 101
 102     //- Runtime type information
 103     TypeName("turbulenceModel");
 104
 105
 106     // Declare run-time constructor selection table
 107
 108         declareRunTimeNewSelectionTable
 109         (
 110             autoPtr,
 111             turbulenceModel,
 112             turbulenceModel,
 113             (
 114                 const volScalarField& rho,
 115                 const volVectorField& U,
 116                 const surfaceScalarField& phi,
 117                 const basicThermo& thermoPhysicalModel,
 118                 const word& turbulenceModelName
 119             ),
 120             (rho, U, phi, thermoPhysicalModel, turbulenceModelName)
 121         );
 122
 123
 124     // Constructors
 125
 126         //- Construct from components
 127         turbulenceModel
 128         (
 129             const volScalarField& rho,
 130             const volVectorField& U,
 131             const surfaceScalarField& phi,
 132             const basicThermo& thermoPhysicalModel,
 133             const word& turbulenceModelName = typeName
 134         );
 135
 136
 137     // Selectors
 138
 139         //- Return a reference to the selected turbulence model
 140         static autoPtr<turbulenceModel> New
 141         (
 142             const volScalarField& rho,
 143             const volVectorField& U,
 144             const surfaceScalarField& phi,
 145             const basicThermo& thermoPhysicalModel,
 146             const word& turbulenceModelName = typeName
 147         );
 148
 149
 150     //- Destructor
 151     virtual ~turbulenceModel()
 152     {}
 153
 154
 155     // Member Functions
 156
 157         //- Access function to density field
 158         const volScalarField& rho() const
 159         {
 160             return rho_;
 161         }
 162
 163         //- Access function to velocity field
 164         const volVectorField& U() const
 165         {
 166             return U_;
 167         }
 168
 169         //- Access function to flux field
 170         const surfaceScalarField& phi() const
 171         {
 172             return phi_;
 173         }
 174
 175         //- Access function to thermophysical model
 176         const basicThermo& thermo() const
 177         {
 178              return thermophysicalModel_;
 179         }
 180
 181         //- Return the laminar viscosity
 182         const volScalarField& mu() const
 183         {
 184             return thermophysicalModel_.mu();
 185         }
 186
 187         //- Return the laminar thermal conductivity
 188         const volScalarField& alpha() const
 189         {
 190             return thermophysicalModel_.alpha();
 191         }
 192
 193         //- Return the turbulence viscosity
 194         virtual tmp<volScalarField> mut() const = 0;
 195
 196         //- Return the effective viscosity
 197         virtual tmp<volScalarField> muEff() const = 0;
 198
 199         //- Return the turbulence thermal diffusivity
 200         virtual tmp<volScalarField> alphat() const = 0;
 201
 202         //- Return the effective turbulence thermal diffusivity
 203         virtual tmp<volScalarField> alphaEff() const = 0;
 204
 205         //- Return the effective turbulence thermal diffusivity for a patch
 206         virtual tmp<scalarField> alphaEff(const label patchI) const = 0;
 207
 208         //- Return the turbulence kinetic energy
 209         virtual tmp<volScalarField> k() const = 0;
 210
 211         //- Return the turbulence kinetic energy dissipation rate
 212         virtual tmp<volScalarField> epsilon() const = 0;
 213
 214         //- Return the laminar+turbulence kinetic energy dissipation rate
 215         //  Used as the viscous contribution to the energy equations
 216         virtual tmp<volScalarField> rhoEpsilonEff() const;
 217
 218         //- Return the Reynolds stress tensor
 219         virtual tmp<volSymmTensorField> R() const = 0;
 220
 221         //- Return the effective stress tensor including the laminar stress
 222         virtual tmp<volSymmTensorField> devRhoReff() const = 0;
 223
 224         //- Return the source term for the momentum equation
 225         virtual tmp<fvVectorMatrix> divDevRhoReff(volVectorField& U) const = 0;
 226
 227         //- Solve the turbulence equations and correct the turbulence viscosity
 228         virtual void correct() = 0;
 229
 230         //- Read LESProperties or RASProperties dictionary
 231         virtual bool read() = 0;
 232
 233         //- Default dummy write function
 234         virtual bool writeData(Ostream&) const
 235         {
 236             return true;
 237         }
 238
 239 };
 240
 241
 242 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 243
 244 } // End namespace compressible
 245 } // End namespace Foam
 246
 247 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 248
 249 #endif
 250
 251 // ************************************************************************* //