src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 Class
  25     Foam::compressible::LESModels::oneEqEddy
  26
  27 Description
  28     One Equation Eddy Viscosity Model for incompressible flows
  29
  30     Eddy viscosity SGS model using a modeled balance equation to simulate the
  31     behaviour of k, hence,
  32     \verbatim
  33         d/dt(rho*k) + div(rho*U*k) - div(muEff*grad(k))
  34         =
  35         -rho*D:B - ce*rho*k^3/2/delta
  36
  37     and
  38
  39         B = 2/3*k*I - 2*nuSgs*dev(D)
  40
  41     where
  42
  43         D = symm(grad(U));
  44         muSgs = ck*rho*sqrt(k)*delta
  45     \endverbatim
  46
  47
  48 SourceFiles
  49     oneEqEddy.C
  50
  51 \*---------------------------------------------------------------------------*/
  52
  53 #ifndef compressibleOneEqEddy_H
  54 #define compressibleOneEqEddy_H
  55
  56 #include "GenEddyVisc.H"
  57
  58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  59
  60 namespace Foam
  61 {
  62 namespace compressible
  63 {
  64 namespace LESModels
  65 {
  66
  67 /*---------------------------------------------------------------------------*\
  68                            Class oneEqEddy Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 class oneEqEddy
  72 :
  73     public GenEddyVisc
  74 {
  75     // Private data
  76
  77         volScalarField k_;
  78
  79         dimensionedScalar ck_;
  80
  81
  82     // Private Member Functions
  83
  84         //- Update sub-grid scale fields
  85         void updateSubGridScaleFields();
  86
  87         // Disallow default bitwise copy construct and assignment
  88         oneEqEddy(const oneEqEddy&);
  89         oneEqEddy& operator=(const oneEqEddy&);
  90
  91
  92 public:
  93
  94     //- Runtime type information
  95     TypeName("oneEqEddy");
  96
  97
  98     // Constructors
  99
 100         //- Constructor from components
 101         oneEqEddy
 102         (
 103             const volScalarField& rho,
 104             const volVectorField& U,
 105             const surfaceScalarField& phi,
 106             const basicThermo& thermoPhysicalModel,
 107             const word& turbulenceModelName = turbulenceModel::typeName,
 108             const word& modelName = typeName
 109         );
 110
 111
 112     //- Destructor
 113     virtual ~oneEqEddy()
 114     {}
 115
 116
 117     // Member Functions
 118
 119         //- Return SGS kinetic energy
 120         virtual tmp<volScalarField> k() const
 121         {
 122             return k_;
 123         }
 124
 125         //- Return the effective diffusivity for k
 126         tmp<volScalarField> DkEff() const
 127         {
 128             return tmp<volScalarField>
 129             (
 130                 new volScalarField("DkEff", muSgs_ + mu())
 131             );
 132         }
 133
 134         //- Correct Eddy-Viscosity and related properties
 135         virtual void correct(const tmp<volTensorField>& gradU);
 136
 137         //- Read LESProperties dictionary
 138         virtual bool read();
 139 };
 140
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 } // End namespace LESModels
 145 } // End namespace compressible
 146 } // End namespace Foam
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #endif
 151
 152 // ************************************************************************* //