Forward compatibility: flex
[foam-extend-3.2.git] / src / turbulenceModels / incompressible / RAS / RNGkEpsilon / RNGkEpsilon.H
blob2446c1143f3be40c35c16a56c5d54a841c8cedbb
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::RASModels::RNGkEpsilon
27 Description
28     Renormalisation group k-epsilon turbulence model for incompressible flows.
30     The default model coefficients correspond to the following:
31     @verbatim
32         RNGkEpsilonCoeffs
33         {
34             Cmu         0.0845;
35             C1          1.42;
36             C2          1.68;
37             sigmak      0.71942;
38             sigmaEps    0.71942;
39             eta0        4.38;
40             beta        0.012;
41         }
42     @endverbatim
44 SourceFiles
45     RNGkEpsilon.C
47 \*---------------------------------------------------------------------------*/
49 #ifndef RNGkEpsilon_H
50 #define RNGkEpsilon_H
52 #include "RASModel.H"
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 namespace Foam
58 namespace incompressible
60 namespace RASModels
63 /*---------------------------------------------------------------------------*\
64                            Class RNGkEpsilon Declaration
65 \*---------------------------------------------------------------------------*/
67 class RNGkEpsilon
69     public RASModel
71     // Private data
73         // Model coefficients
75             dimensionedScalar Cmu_;
76             dimensionedScalar C1_;
77             dimensionedScalar C2_;
78             dimensionedScalar sigmak_;
79             dimensionedScalar sigmaEps_;
80             dimensionedScalar eta0_;
81             dimensionedScalar beta_;
84         // Fields
86             volScalarField k_;
87             volScalarField epsilon_;
88             volScalarField nut_;
91 public:
93     //- Runtime type information
94     TypeName("RNGkEpsilon");
96     // Constructors
98         //- Construct from components
99         RNGkEpsilon
100         (
101             const volVectorField& U,
102             const surfaceScalarField& phi,
103             transportModel& transport
104         );
107     //- Destructor
108     virtual ~RNGkEpsilon()
109     {}
112     // Member Functions
114         //- Return the turbulence viscosity
115         virtual tmp<volScalarField> nut() const
116         {
117             return nut_;
118         }
120         //- Return the effective diffusivity for k
121         tmp<volScalarField> DkEff() const
122         {
123             return tmp<volScalarField>
124             (
125                 new volScalarField("DkEff", nut_/sigmak_ + nu())
126             );
127         }
129         //- Return the effective diffusivity for epsilon
130         tmp<volScalarField> DepsilonEff() const
131         {
132             return tmp<volScalarField>
133             (
134                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
135             );
136         }
138         //- Return the turbulence kinetic energy
139         virtual tmp<volScalarField> k() const
140         {
141             return k_;
142         }
144         //- Return the turbulence kinetic energy dissipation rate
145         virtual tmp<volScalarField> epsilon() const
146         {
147             return epsilon_;
148         }
150         //- Return the Reynolds stress tensor
151         virtual tmp<volSymmTensorField> R() const;
153         //- Return the effective stress tensor including the laminar stress
154         virtual tmp<volSymmTensorField> devReff() const;
156         //- Return the source term for the momentum equation
157         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
159         //- Solve the turbulence equations and correct the turbulence viscosity
160         virtual void correct();
162         //- Read RASProperties dictionary
163         virtual bool read();
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 } // End namespace RASModels
170 } // End namespace incompressible
171 } // End namespace Foam
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 #endif
177 // ************************************************************************* //