src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.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::incompressible::LESModels::GenSGSStress
  26
  27 Description
  28     General base class for all incompressible models that directly
  29     solve for the SGS stress tensor B.
  30
  31     Contains tensor fields B (the SGS stress tensor) as well as scalar
  32     fields for k (SGS turbulent energy) gamma (SGS viscosity) and epsilon
  33     (SGS dissipation).
  34
  35 SourceFiles
  36     GenSGSStress.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef GenSGSStress_H
  41 #define GenSGSStress_H
  42
  43 #include "LESModel.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49 namespace incompressible
  50 {
  51 namespace LESModels
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class GenSGSStress Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class GenSGSStress
  59 :
  60     virtual public LESModel
  61 {
  62     // Private Member Functions
  63
  64         // Disallow default bitwise copy construct and assignment
  65         GenSGSStress(const GenSGSStress&);
  66         GenSGSStress& operator=(const GenSGSStress&);
  67
  68
  69 protected:
  70
  71         dimensionedScalar ce_;
  72
  73         dimensionedScalar couplingFactor_;
  74
  75         volSymmTensorField B_;
  76         volScalarField nuSgs_;
  77
  78
  79 public:
  80
  81     //- Partial Runtime type information
  82     static const word typeName;
  83
  84     // Constructors
  85
  86         //- Construct from components
  87         GenSGSStress
  88         (
  89             const volVectorField& U,
  90             const surfaceScalarField& phi,
  91             transportModel& transport,
  92             const word& turbulenceModelName = turbulenceModel::typeName,
  93             const word& modelName = typeName
  94         );
  95
  96
  97     //- Destructor
  98     virtual ~GenSGSStress()
  99     {}
 100
 101
 102     // Member Functions
 103
 104         //- Return the SGS turbulent kinetic energy.
 105         virtual tmp<volScalarField> k() const
 106         {
 107             return 0.5*tr(B_);
 108         }
 109
 110         //- Return the SGS turbulent dissipation.
 111         virtual tmp<volScalarField> epsilon() const
 112         {
 113             const volScalarField K(k());
 114             return ce_*K*sqrt(K)/delta();
 115         }
 116
 117         //- Return the SGS viscosity.
 118         virtual tmp<volScalarField> nuSgs() const
 119         {
 120             return nuSgs_;
 121         }
 122
 123         //- Return the sub-grid stress tensor.
 124         virtual tmp<volSymmTensorField> B() const
 125         {
 126             return B_;
 127         }
 128
 129         //- Return the effective sub-grid turbulence stress tensor
 130         //  including the laminar stress
 131         virtual tmp<volSymmTensorField> devBeff() const;
 132
 133         //- Returns div(B).
 134         // This is the additional term due to the filtering of the NSE.
 135         virtual tmp<fvVectorMatrix> divDevBeff(volVectorField& U) const;
 136
 137         //- Read LESProperties dictionary
 138         virtual bool read();
 139 };
 140
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 } // End namespace LESModels
 145 } // End namespace incompressible
 146 } // End namespace Foam
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #endif
 151
 152 // ************************************************************************* //