initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / turbulenceModels / incompressible / LES / Smagorinsky2 / Smagorinsky2.H
blob015dda7a14e78e8fd2539676fd50003a77a8aa68
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.
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.
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.
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
25 Class
26     Foam::incompressible::LESModels::Smagorinsky2
28 Description
29     The Isochoric Smagorinsky Model for incompressible flows
31     Algebraic eddy viscosity SGS model founded on the assumption that
32     local equilibrium prevails, hence
33     @verbatim
34         B = 2/3*k*I - 2*nuSgs*dev(D) - 2*cD2*delta*(D.dev(D));
35         Beff = 2/3*k*I - 2*nuEff*dev(D) - 2*cD2*delta*(D.dev(D));
37     where
39         D = symm(grad(U));
40         k = cI*delta^2*||D||^2
41         nuSgs = ck*sqrt(k)*delta
42         nuEff = nuSgs + nu
43     @endverbatim
45 SourceFiles
46     Smagorinsky2.C
48 \*---------------------------------------------------------------------------*/
50 #ifndef Smagorinsky2_H
51 #define Smagorinsky2_H
53 #include "Smagorinsky.H"
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
57 namespace Foam
59 namespace incompressible
61 namespace LESModels
64 /*---------------------------------------------------------------------------*\
65                            Class Smagorinsky2 Declaration
66 \*---------------------------------------------------------------------------*/
68 class Smagorinsky2
70     public Smagorinsky
72     // Private data
74         dimensionedScalar cD2_;
77     // Private Member Functions
79         // Disallow default bitwise copy construct and assignment
80         Smagorinsky2(const Smagorinsky2&);
81         Smagorinsky2& operator=(const Smagorinsky2&);
84 public:
86     //- Runtime type information
87     TypeName("Smagorinsky2");
90     // Constructors
92         //- Construct from components
93         Smagorinsky2
94         (
95             const volVectorField& U,
96             const surfaceScalarField& phi,
97             transportModel& transport
98         );
101     //- Destructor
102     virtual ~Smagorinsky2()
103     {}
106     // Member Functions
108         //- Return B.
109         virtual tmp<volSymmTensorField> B() const;
111         //- Returns div(B).
112         // This is the additional term due to the filtering of the NSE.
113         virtual tmp<fvVectorMatrix> divDevBeff(volVectorField& U) const;
115         //- Read LESProperties dictionary
116         virtual bool read();
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 } // End namespace LESModels
123 } // End namespace incompressible
124 } // End namespace Foam
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 #endif
130 // ************************************************************************* //