initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / turbulenceModels / LES / compressible / Smagorinsky / Smagorinsky.H
blobe5d786f94af8fb204c44bc1438ccc4bd65fcdcf5
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.
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::compressible::LESModels::Smagorinsky
28 Description
29     The choric Smagorinsky Model for compressible flows.
31     Algebraic eddy viscosity SGS model founded on the assumption that
32     local equilibrium prevails.
33     Thus,
34     @verbatim
36         B = 2/3*k*I - 2*nuSgs*dev(D)
38     where
40         D = symm(grad(U));
41         k from rho*D:B + ce*rho*k^3/2/delta = 0
42         muSgs = ck*rho*sqrt(k)*delta
43     @endverbatim
45 SourceFiles
46     Smagorinsky.C
48 \*---------------------------------------------------------------------------*/
50 #ifndef compressibleSmagorinsky_H
51 #define compressibleSmagorinsky_H
53 #include "GenEddyVisc.H"
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
57 namespace Foam
59 namespace compressible
61 namespace LESModels
64 /*---------------------------------------------------------------------------*\
65                            Class Smagorinsky Declaration
66 \*---------------------------------------------------------------------------*/
68 class Smagorinsky
70     public GenEddyVisc
72     // Private data
74         dimensionedScalar ck_;
77     // Private Member Functions
79         // Disallow default bitwise copy construct and assignment
80         Smagorinsky(const Smagorinsky&);
81         Smagorinsky& operator=(const Smagorinsky&);
84 public:
86     //- Runtime type information
87     TypeName("Smagorinsky");
89     // Constructors
91         //- Construct from components
92         Smagorinsky
93         (
94             const volScalarField& rho,
95             const volVectorField& U,
96             const surfaceScalarField& phi,
97             const basicThermo& thermoPhysicalModel
98         );
101     // Destructor
103         ~Smagorinsky()
104         {}
107     // Member Functions
109         //- Correct Eddy-Viscosity and related properties
110         void correct(const tmp<volTensorField>& gradU);
112         //- Read turbulenceProperties dictionary
113         bool read();
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 } // End namespace LESModels
120 } // End namespace compressible
121 } // End namespace Foam
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 #endif
127 // ************************************************************************* //