src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::incompressible::LESModels::GenEddyVisc
  26
  27 Description
  28     General base class for all incompressible models that can be implemented
  29     as an eddy viscosity, i.e. algebraic and one-equation models.
  30
  31     Contains fields for k (SGS turbulent kinetic energy), gamma
  32     (modelled viscosity) and epsilon (SGS dissipation).
  33
  34 SourceFiles
  35     GenEddyVisc.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef GenEddyVisc_H
  40 #define GenEddyVisc_H
  41
  42 #include "LESModel.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48 namespace incompressible
  49 {
  50 namespace LESModels
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class GenEddyVisc Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class GenEddyVisc
  58 :
  59     virtual public LESModel
  60 {
  61     // Private Member Functions
  62
  63         // Disallow default bitwise copy construct and assignment
  64         GenEddyVisc(const GenEddyVisc&);
  65         GenEddyVisc& operator=(const GenEddyVisc&);
  66
  67
  68 protected:
  69
  70         dimensionedScalar ce_;
  71
  72         volScalarField nuSgs_;
  73
  74
  75 public:
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         GenEddyVisc
  81         (
  82             const volVectorField& U,
  83             const surfaceScalarField& phi,
  84             transportModel& transport
  85         );
  86
  87
  88     //- Destructor
  89     virtual ~GenEddyVisc()
  90     {}
  91
  92
  93     // Member Functions
  94
  95         //- Return SGS kinetic energy
  96         virtual tmp<volScalarField> k() const = 0;
  97
  98         //- Return sub-grid disipation rate
  99         virtual tmp<volScalarField> epsilon() const
 100         {
 101             return ce_*k()*sqrt(k())/delta();
 102         }
 103
 104         //- Return the SGS viscosity.
 105         virtual tmp<volScalarField> nuSgs() const
 106         {
 107             return nuSgs_;
 108         }
 109
 110         //- Return the sub-grid stress tensor.
 111         virtual tmp<volSymmTensorField> B() const;
 112
 113         //- Return the effective sub-grid turbulence stress tensor
 114         //  including the laminar stress
 115         virtual tmp<volSymmTensorField> devBeff() const;
 116
 117         //- Return the deviatoric part of the effective sub-grid
 118         //  turbulence stress tensor including the laminar stress
 119         virtual tmp<fvVectorMatrix> divDevBeff(volVectorField& U) const;
 120
 121         //- Correct Eddy-Viscosity and related properties
 122         virtual void correct(const tmp<volTensorField>& gradU);
 123
 124         //- Read LESProperties dictionary
 125         virtual bool read();
 126 };
 127
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 } // End namespace LESModels
 132 } // End namespace incompressible
 133 } // End namespace Foam
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //