src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.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 Class
  26     Foam::compressible::LESModels::GenEddyVisc
  27
  28 Description
  29     General base class for all compressible models that can be implemented as
  30     an eddy viscosity, i.e. algebraic and one-equation models.
  31
  32     Contains fields for k (SGS turbulent kinetic energy), gamma
  33     (modelled viscosity) and epsilon (SGS dissipation).
  34
  35 SourceFiles
  36     GenEddyVisc.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef compressibleGenEddyVisc_H
  41 #define compressibleGenEddyVisc_H
  42
  43 #include "LESModel.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49 namespace compressible
  50 {
  51 namespace LESModels
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class GenEddyVisc Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class GenEddyVisc
  59 :
  60     virtual public LESModel
  61 {
  62     // Private Member Functions
  63
  64         // Disallow default bitwise copy construct and assignment
  65         GenEddyVisc(const GenEddyVisc&);
  66         GenEddyVisc& operator=(const GenEddyVisc&);
  67
  68
  69 protected:
  70
  71     // Model coefficients
  72
  73         dimensionedScalar ce_;
  74         dimensionedScalar Prt_;
  75
  76
  77     // Fields
  78
  79         volScalarField k_;
  80         volScalarField muSgs_;
  81         volScalarField alphaSgs_;
  82
  83
  84 public:
  85
  86     // Constructors
  87
  88         //- Construct from components
  89         GenEddyVisc
  90         (
  91             const volScalarField& rho,
  92             const volVectorField& U,
  93             const surfaceScalarField& phi,
  94             const basicThermo& thermoPhysicalModel
  95         );
  96
  97
  98     //- Destructor
  99     virtual ~GenEddyVisc()
 100     {}
 101
 102
 103     // Member Functions
 104
 105         //- Return SGS kinetic energy
 106         virtual tmp<volScalarField> k() const
 107         {
 108             return k_;
 109         }
 110
 111         //- Return sub-grid disipation rate
 112         virtual tmp<volScalarField> epsilon() const
 113         {
 114             return ce_*k_*sqrt(k_)/delta();
 115         }
 116
 117         //- Return viscosity
 118         virtual tmp<volScalarField> muSgs() const
 119         {
 120             return muSgs_;
 121         }
 122
 123         //- Return thermal diffusivity
 124         virtual tmp<volScalarField> alphaSgs() const
 125         {
 126             return alphaSgs_;
 127         }
 128
 129         //- Return thermal diffusivity
 130         virtual tmp<volScalarField> alphaEff() const
 131         {
 132             return tmp<volScalarField>
 133             (
 134                 new volScalarField("alphaEff", alphaSgs_ + alpha())
 135             );
 136         }
 137
 138         //- Return the sub-grid stress tensor.
 139         virtual tmp<volSymmTensorField> B() const;
 140
 141         //- Return the deviatoric part of the effective sub-grid
 142         //  turbulence stress tensor including the laminar stress
 143         virtual tmp<volSymmTensorField> devRhoBeff() const;
 144
 145         //- Returns div(rho*dev(B)).
 146         // This is the additional term due to the filtering of the NSE.
 147         virtual tmp<fvVectorMatrix> divDevRhoBeff(volVectorField& U) const;
 148
 149         //- Correct Eddy-Viscosity and related properties
 150         virtual void correct(const tmp<volTensorField>& gradU);
 151
 152         //- Read LESProperties dictionary
 153         virtual bool read();
 154 };
 155
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 } // End namespace LESModels
 160 } // End namespace compressible
 161 } // End namespace Foam
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 #endif
 166
 167 // ************************************************************************* //