src/turbulenceModels/compressible/turbulenceModel/turbulenceModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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 "objectRegistry.H"
  48 #include "primitiveFieldsFwd.H"
  49 #include "volFieldsFwd.H"
  50 #include "surfaceFieldsFwd.H"
  51 #include "fvMatricesFwd.H"
  52 #include "basicThermo.H"
  53 #include "autoPtr.H"
  54 #include "runTimeSelectionTables.H"
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 namespace Foam
  59 {
  60
  61 // Forward declarations
  62 class fvMesh;
  63
  64 namespace compressible
  65 {
  66
  67 /*---------------------------------------------------------------------------*\
  68                        Class turbulenceModel Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 class turbulenceModel
  72 {
  73
  74 protected:
  75
  76     // Protected data
  77
  78         const Time& runTime_;
  79         const fvMesh& mesh_;
  80
  81         const volScalarField& rho_;
  82         const volVectorField& U_;
  83         const surfaceScalarField& phi_;
  84
  85         const basicThermo& thermophysicalModel_;
  86
  87
  88 private:
  89
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         turbulenceModel(const turbulenceModel&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const turbulenceModel&);
  97
  98
  99 public:
 100
 101     //- Runtime type information
 102     TypeName("turbulenceModel");
 103
 104
 105     // Declare run-time constructor selection table
 106
 107 #ifndef SWIG
 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             ),
 119             (rho, U, phi, thermoPhysicalModel)
 120         );
 121 #endif
 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         );
 134
 135
 136     // Selectors
 137
 138         //- Return a reference to the selected turbulence model
 139         static autoPtr<compressible::turbulenceModel> New
 140         (
 141             const volScalarField& rho,
 142             const volVectorField& U,
 143             const surfaceScalarField& phi,
 144             const basicThermo& thermoPhysicalModel
 145         );
 146
 147
 148     //- Destructor
 149     virtual ~turbulenceModel()
 150     {}
 151
 152
 153     // Member Functions
 154
 155         //- Access function to density field
 156         const volScalarField& rho() const
 157         {
 158             return rho_;
 159         }
 160
 161         //- Access function to velocity field
 162         const volVectorField& U() const
 163         {
 164             return U_;
 165         }
 166
 167         //- Access function to flux field
 168         const surfaceScalarField& phi() const
 169         {
 170             return phi_;
 171         }
 172
 173         //- Access function to thermophysical model
 174         const basicThermo& thermo() const
 175         {
 176              return thermophysicalModel_;
 177         }
 178
 179         //- Return the laminar viscosity
 180         const volScalarField& mu() const
 181         {
 182             return thermophysicalModel_.mu();
 183         }
 184
 185         //- Return the laminar thermal conductivity
 186         const volScalarField& alpha() const
 187         {
 188             return thermophysicalModel_.alpha();
 189         }
 190
 191         //- Return the turbulence viscosity
 192         virtual tmp<volScalarField> mut() const = 0;
 193
 194         //- Return the effective viscosity
 195         virtual tmp<volScalarField> muEff() const = 0;
 196
 197         //- Return the effective turbulent thermal diffusivity
 198         virtual tmp<volScalarField> alphaEff() const = 0;
 199
 200         //- Return the turbulence kinetic energy
 201         virtual tmp<volScalarField> k() const = 0;
 202
 203         //- Return the turbulence kinetic energy dissipation rate
 204         virtual tmp<volScalarField> epsilon() const = 0;
 205
 206         //- Return the Reynolds stress tensor
 207         virtual tmp<volSymmTensorField> R() const = 0;
 208
 209         //- Return the effective stress tensor including the laminar stress
 210         virtual tmp<volSymmTensorField> devRhoReff() const = 0;
 211
 212         //- Return the source term for the momentum equation
 213         virtual tmp<fvVectorMatrix> divDevRhoReff(volVectorField& U) const = 0;
 214
 215         //- Solve the turbulence equations and correct the turbulence viscosity
 216         virtual void correct() = 0;
 217
 218         //- Read turbulenceProperties dictionary
 219         virtual bool read() = 0;
 220 };
 221
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 } // End namespace compressible
 226 } // End namespace Foam
 227
 228 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 229
 230 #endif
 231
 232 // ************************************************************************* //