ENH: patchCloud: return pTraits<Type>::max for unfound points
[OpenFOAM-1.7.x.git] / src / turbulenceModels / incompressible / LES / Smagorinsky2 / Smagorinsky2.H
blobe3923ebf56e00ccbbb3877a960f902ab1f845f5d
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::incompressible::LESModels::Smagorinsky2
27 Description
28     The Isochoric Smagorinsky Model for incompressible flows
30     Algebraic eddy viscosity SGS model founded on the assumption that
31     local equilibrium prevails, hence
32     @verbatim
33         B = 2/3*k*I - 2*nuSgs*dev(D) - 2*cD2*delta*(D.dev(D));
34         Beff = 2/3*k*I - 2*nuEff*dev(D) - 2*cD2*delta*(D.dev(D));
36     where
38         D = symm(grad(U));
39         k = cI*delta^2*||D||^2
40         nuSgs = ck*sqrt(k)*delta
41         nuEff = nuSgs + nu
42     @endverbatim
44 SourceFiles
45     Smagorinsky2.C
47 \*---------------------------------------------------------------------------*/
49 #ifndef Smagorinsky2_H
50 #define Smagorinsky2_H
52 #include "Smagorinsky.H"
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 namespace Foam
58 namespace incompressible
60 namespace LESModels
63 /*---------------------------------------------------------------------------*\
64                            Class Smagorinsky2 Declaration
65 \*---------------------------------------------------------------------------*/
67 class Smagorinsky2
69     public Smagorinsky
71     // Private data
73         dimensionedScalar cD2_;
76     // Private Member Functions
78         // Disallow default bitwise copy construct and assignment
79         Smagorinsky2(const Smagorinsky2&);
80         Smagorinsky2& operator=(const Smagorinsky2&);
83 public:
85     //- Runtime type information
86     TypeName("Smagorinsky2");
89     // Constructors
91         //- Construct from components
92         Smagorinsky2
93         (
94             const volVectorField& U,
95             const surfaceScalarField& phi,
96             transportModel& transport
97         );
100     //- Destructor
101     virtual ~Smagorinsky2()
102     {}
105     // Member Functions
107         //- Return B.
108         virtual tmp<volSymmTensorField> B() const;
110         //- Returns div(B).
111         // This is the additional term due to the filtering of the NSE.
112         virtual tmp<fvVectorMatrix> divDevBeff(volVectorField& U) const;
114         //- Read LESProperties dictionary
115         virtual bool read();
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 } // End namespace LESModels
122 } // End namespace incompressible
123 } // End namespace Foam
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 #endif
129 // ************************************************************************* //