src/turbulenceModels/LES/incompressible/Smagorinsky/Smagorinsky.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::Smagorinsky
  27
  28 Description
  29     The Isochoric Smagorinsky Model for incompressible flows.
  30
  31     Algebraic eddy viscosity SGS model founded on the assumption that
  32     local equilibrium prevails.
  33     Thus,
  34     @verbatim
  35         B = 2/3*k*I - 2*nuSgs*dev(D)
  36         Beff = 2/3*k*I - 2*nuEff*dev(D)
  37
  38     where
  39
  40         D = symm(grad(U));
  41         k = (2*ck/ce)*delta^2*||D||^2
  42         nuSgs = ck*sqrt(k)*delta
  43         nuEff = nuSgs + nu
  44     @endverbatim
  45
  46 SourceFiles
  47     Smagorinsky.C
  48
  49 \*---------------------------------------------------------------------------*/
  50
  51 #ifndef Smagorinsky_H
  52 #define Smagorinsky_H
  53
  54 #include "GenEddyVisc.H"
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 namespace Foam
  59 {
  60 namespace incompressible
  61 {
  62 namespace LESModels
  63 {
  64
  65 /*---------------------------------------------------------------------------*\
  66                            Class Smagorinsky Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 class Smagorinsky
  70 :
  71     public GenEddyVisc
  72 {
  73     // Private data
  74
  75         dimensionedScalar ck_;
  76
  77
  78     // Private Member Functions
  79
  80         // Disallow default bitwise copy construct and assignment
  81         Smagorinsky(const Smagorinsky&);
  82         Smagorinsky& operator=(const Smagorinsky&);
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("Smagorinsky");
  89
  90     // Constructors
  91
  92         //- Construct from components
  93         Smagorinsky
  94         (
  95             const volVectorField& U,
  96             const surfaceScalarField& phi,
  97             transportModel& transport
  98         );
  99
 100
 101     // Destructor
 102
 103         ~Smagorinsky()
 104         {}
 105
 106
 107     // Member Functions
 108
 109         //- Return SGS kinetic energy
 110         //  calculated from the given velocity gradient
 111         tmp<volScalarField> k(const tmp<volTensorField>& gradU) const
 112         {
 113             return (2.0*ck_/ce_)*sqr(delta())*magSqr(dev(symm(gradU)));
 114         }
 115
 116         //- Return SGS kinetic energy
 117         tmp<volScalarField> k() const
 118         {
 119             return k(fvc::grad(U()));
 120         }
 121
 122
 123         //- Correct Eddy-Viscosity and related properties
 124         virtual void correct(const tmp<volTensorField>& gradU);
 125
 126         //- Read turbulenceProperties dictionary
 127         virtual bool read();
 128 };
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace LESModels
 134 } // End namespace incompressible
 135 } // End namespace Foam
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #endif
 140
 141 // ************************************************************************* //