src/turbulenceModels/compressible/RAS/RASModel/RASModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Namespace
  26     Foam::compressible::RASModels
  27
  28 Description
  29     Namespace for compressible RAS turbulence models.
  30
  31
  32 Class
  33     Foam::compressible::RASModel
  34
  35 Description
  36     Abstract base class for turbulence models for compressible and combusting
  37     flows.
  38
  39 SourceFiles
  40     RASModel.C
  41     newTurbulenceModel.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef compressibleRASModel_H
  46 #define compressibleRASModel_H
  47
  48 #include "compressible/turbulenceModel/turbulenceModel.H"
  49 #include "volFields.H"
  50 #include "surfaceFields.H"
  51 #include "nearWallDist.H"
  52 #include "fvm.H"
  53 #include "fvc.H"
  54 #include "fvMatrices.H"
  55 #include "basicThermo.H"
  56 #include "IOdictionary.H"
  57 #include "Switch.H"
  58 #include "bound.H"
  59 #include "autoPtr.H"
  60 #include "runTimeSelectionTables.H"
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 namespace Foam
  65 {
  66 namespace compressible
  67 {
  68
  69 /*---------------------------------------------------------------------------*\
  70                            Class RASModel Declaration
  71 \*---------------------------------------------------------------------------*/
  72
  73 class RASModel
  74 :
  75     public turbulenceModel,
  76     public IOdictionary
  77 {
  78
  79 protected:
  80
  81     // Protected data
  82
  83         //- Turbulence on/off flag
  84         Switch turbulence_;
  85
  86         //- Flag to print the model coeffs at run-time
  87         Switch printCoeffs_;
  88
  89         //- Model coefficients dictionary
  90         dictionary coeffDict_;
  91
  92         //- Value of y+ at the edge of the laminar sublayer
  93         scalar yPlusLam_;
  94
  95         //- Lower limit of k
  96         dimensionedScalar k0_;
  97
  98         //- Lower limit of epsilon
  99         dimensionedScalar epsilon0_;
 100
 101         //- Small epsilon value used to avoid divide by zero
 102         dimensionedScalar epsilonSmall_;
 103
 104         //- Lower limit for omega
 105         dimensionedScalar omega0_;
 106
 107         //- Small omega value used to avoid divide by zero
 108         dimensionedScalar omegaSmall_;
 109
 110         //- Near wall distance boundary field
 111         nearWallDist y_;
 112
 113
 114     // Protected member functions
 115
 116         //- Print model coefficients
 117         virtual void printCoeffs();
 118
 119
 120 private:
 121
 122     // Private Member Functions
 123
 124         //- Disallow default bitwise copy construct
 125         RASModel(const RASModel&);
 126
 127         //- Disallow default bitwise assignment
 128         void operator=(const RASModel&);
 129
 130
 131 public:
 132
 133     //- Runtime type information
 134     TypeName("RASModel");
 135
 136
 137     // Declare run-time constructor selection table
 138
 139         declareRunTimeSelectionTable
 140         (
 141             autoPtr,
 142             RASModel,
 143             dictionary,
 144             (
 145                 const volScalarField& rho,
 146                 const volVectorField& U,
 147                 const surfaceScalarField& phi,
 148                 const basicThermo& thermoPhysicalModel
 149             ),
 150             (rho, U, phi, thermoPhysicalModel)
 151         );
 152
 153
 154     // Constructors
 155
 156         //- Construct from components
 157         RASModel
 158         (
 159             const word& type,
 160             const volScalarField& rho,
 161             const volVectorField& U,
 162             const surfaceScalarField& phi,
 163             const basicThermo& thermoPhysicalModel
 164         );
 165
 166
 167     // Selectors
 168
 169         //- Return a reference to the selected turbulence model
 170         static autoPtr<RASModel> New
 171         (
 172             const volScalarField& rho,
 173             const volVectorField& U,
 174             const surfaceScalarField& phi,
 175             const basicThermo& thermoPhysicalModel
 176         );
 177
 178
 179     //- Destructor
 180     virtual ~RASModel()
 181     {}
 182
 183
 184     // Member Functions
 185
 186         // Access
 187
 188             //- Return the value of k0 which k is not allowed to be less than
 189             const dimensionedScalar& k0() const
 190             {
 191                 return k0_;
 192             }
 193
 194             //- Return the value of epsilon0 which epsilon is not allowed to be
 195             //  less than
 196             const dimensionedScalar& epsilon0() const
 197             {
 198                 return epsilon0_;
 199             }
 200
 201             //- Return the value of epsilonSmall which is added to epsilon when
 202             //  calculating nut
 203             const dimensionedScalar& epsilonSmall() const
 204             {
 205                 return epsilonSmall_;
 206             }
 207
 208             //- Return the value of omega0 which epsilon is not allowed to be
 209             //  less than
 210             const dimensionedScalar& omega0() const
 211             {
 212                 return omega0_;
 213             }
 214
 215             //- Return the value of omegaSmall which is added to epsilon when
 216             //  calculating nut
 217             const dimensionedScalar& omegaSmall() const
 218             {
 219                 return omegaSmall_;
 220             }
 221
 222             //- Allow k0 to be changed
 223             dimensionedScalar& k0()
 224             {
 225                 return k0_;
 226             }
 227
 228             //- Allow epsilon0 to be changed
 229             dimensionedScalar& epsilon0()
 230             {
 231                 return epsilon0_;
 232             }
 233
 234             //- Allow epsilonSmall to be changed
 235             dimensionedScalar& epsilonSmall()
 236             {
 237                 return epsilonSmall_;
 238             }
 239
 240             //- Allow omega0 to be changed
 241             dimensionedScalar& omega0()
 242             {
 243                 return omega0_;
 244             }
 245
 246             //- Allow omegaSmall to be changed
 247             dimensionedScalar& omegaSmall()
 248             {
 249                 return omegaSmall_;
 250             }
 251
 252             //- Return the near wall distances
 253             const nearWallDist& y() const
 254             {
 255                 return y_;
 256             }
 257
 258             //- Calculate y+ at the edge of the laminar sublayer
 259             scalar yPlusLam(const scalar kappa, const scalar E) const;
 260
 261             //- Const access to the coefficients dictionary
 262             const dictionary& coeffDict() const
 263             {
 264                 return coeffDict_;
 265             }
 266
 267
 268         //- Return the turbulence viscosity
 269         virtual tmp<volScalarField> mut() const = 0;
 270
 271         //- Return the effective viscosity
 272         virtual tmp<volScalarField> muEff() const
 273         {
 274             return tmp<volScalarField>
 275             (
 276                 new volScalarField("muEff", mut() + mu())
 277             );
 278         }
 279
 280         //- Return the effective turbulent thermal diffusivity
 281         virtual tmp<volScalarField> alphaEff() const = 0;
 282
 283         //- Return the turbulence kinetic energy
 284         virtual tmp<volScalarField> k() const = 0;
 285
 286         //- Return the turbulence kinetic energy dissipation rate
 287         virtual tmp<volScalarField> epsilon() const = 0;
 288
 289         //- Return the Reynolds stress tensor
 290         virtual tmp<volSymmTensorField> R() const = 0;
 291
 292         //- Return the effective stress tensor including the laminar stress
 293         virtual tmp<volSymmTensorField> devRhoReff() const = 0;
 294
 295         //- Return the source term for the momentum equation
 296         virtual tmp<fvVectorMatrix> divDevRhoReff(volVectorField& U) const = 0;
 297
 298         //- Return yPlus for the given patch
 299         virtual tmp<scalarField> yPlus
 300         (
 301             const label patchI,
 302             const scalar Cmu
 303         ) const;
 304
 305         //- Solve the turbulence equations and correct the turbulence viscosity
 306         virtual void correct() = 0;
 307
 308         //- Read RASProperties dictionary
 309         virtual bool read() = 0;
 310 };
 311
 312
 313 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 314
 315 } // End namespace compressible
 316 } // End namespace Foam
 317
 318 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 319
 320 #endif
 321
 322 // ************************************************************************* //