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