Forward compatibility: flex
[foam-extend-3.2.git] / src / turbulenceModels / incompressible / LES / oneEqEddy / oneEqEddy.H
blobed255db1d8acdcf1dfcc92318bbf44cca77fc624
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.
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.
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.
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/>.
24 Class
25     Foam::incompressible::LESModels::oneEqEddy
27 Description
28     One Equation Eddy Viscosity Model for incompressible flows
30     Eddy viscosity SGS model using a modeled balance equation to simulate the
31     behaviour of k, hence,
32     @verbatim
33         d/dt(k) + div(U*k) - div(nuEff*grad(k))
34         =
35         -B*L - ce*k^3/2/delta
37     and
39         B = 2/3*k*I - 2*nuSgs*dev(D)
40         Beff = 2/3*k*I - 2*nuEff*dev(D)
42     where
44         D = symm(grad(U));
45         nuSgs = ck*sqrt(k)*delta
46         nuEff = nuSgs + nu
47     @endverbatim
49 SourceFiles
50     oneEqEddy.C
52 \*---------------------------------------------------------------------------*/
54 #ifndef oneEqEddy_H
55 #define oneEqEddy_H
57 #include "GenEddyVisc.H"
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 namespace Foam
63 namespace incompressible
65 namespace LESModels
68 /*---------------------------------------------------------------------------*\
69                            Class oneEqEddy Declaration
70 \*---------------------------------------------------------------------------*/
72 class oneEqEddy
74     public GenEddyVisc
76     // Private data
78         volScalarField k_;
80         dimensionedScalar ck_;
83     // Private Member Functions
85         //- Update sub-grid scale fields
86         void updateSubGridScaleFields();
88         // Disallow default bitwise copy construct and assignment
89         oneEqEddy(const oneEqEddy&);
90         oneEqEddy& operator=(const oneEqEddy&);
93 public:
95     //- Runtime type information
96     TypeName("oneEqEddy");
98     // Constructors
100         //- Construct from components
101         oneEqEddy
102         (
103             const volVectorField& U,
104             const surfaceScalarField& phi,
105             transportModel& transport
106         );
109     //- Destructor
110     virtual ~oneEqEddy()
111     {}
114     // Member Functions
116         //- Return SGS kinetic energy
117         virtual tmp<volScalarField> k() const
118         {
119             return k_;
120         }
122         //- Return the effective diffusivity for k
123         tmp<volScalarField> DkEff() const
124         {
125             return tmp<volScalarField>
126             (
127                 new volScalarField("DkEff", nuSgs_ + nu())
128             );
129         }
131         //- Correct Eddy-Viscosity and related properties
132         virtual void correct(const tmp<volTensorField>& gradU);
134         //- Read LESProperties dictionary
135         virtual bool read();
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 } // End namespace LESModels
142 } // End namespace incompressible
143 } // End namespace Foam
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 #endif
149 // ************************************************************************* //