Forward compatibility: flex
[foam-extend-3.2.git] / src / turbulenceModels / incompressible / RAS / LienCubicKELowRe / LienCubicKELowRe.H
blobf6476f467555e9a7f046035ace7886a27a08596d
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::LienCubicKELowRe
27 Description
28     Lien cubic non-linear low-Reynolds k-epsilon turbulence models for
29     incompressible flows.
31     References:
32     @verbatim
33         Lien, F.S., Chen, W.L., Leschziner, M.A.,
34         "Low-Reynolds-number eddy-viscosity modeling based on non-linear
35          stress-strain/vorticity relations"
36         Engineering Turbulence Modelling and Experiments 3
37         (Edited by Rodi, W. and Bergeles, G.), 91-100. 1996.
38         Elsevier Science Publishers.
40         Etemad, S., et al.,
41         "Turbulent flow and heat transfer in a square-sectioned U bend"
42         Progress in compuational fluid dynamics 6, 89-100. 2006.
43     @endverbatim
45 SourceFiles
46     LienCubicKELowRe.C
48 \*---------------------------------------------------------------------------*/
50 #ifndef LienCubicKELowRe_H
51 #define LienCubicKELowRe_H
53 #include "RASModel.H"
54 #include "wallDist.H"
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 namespace Foam
60 namespace incompressible
62 namespace RASModels
65 /*---------------------------------------------------------------------------*\
66                            Class LienCubicKELowRe Declaration
67 \*---------------------------------------------------------------------------*/
69 class LienCubicKELowRe
71     public RASModel
73     // Private data
75         // Model coefficients
77             dimensionedScalar C1_;
78             dimensionedScalar C2_;
79             dimensionedScalar sigmak_;
80             dimensionedScalar sigmaEps_;
81             dimensionedScalar A1_;
82             dimensionedScalar A2_;
83             dimensionedScalar Ctau1_;
84             dimensionedScalar Ctau2_;
85             dimensionedScalar Ctau3_;
86             dimensionedScalar alphaKsi_;
88             dimensionedScalar CmuWall_;
89             dimensionedScalar kappa_;
91             dimensionedScalar Am_;
92             dimensionedScalar Aepsilon_;
93             dimensionedScalar Amu_;
96         // Fields
98             volScalarField k_;
99             volScalarField epsilon_;
101             wallDist y_;
103             volTensorField gradU_;
104             volScalarField eta_;
105             volScalarField ksi_;
106             volScalarField Cmu_;
107             volScalarField fEta_;
108             volScalarField C5viscosity_;
110             volScalarField yStar_;
112             volScalarField nut_;
114             volSymmTensorField nonlinearStress_;
117 public:
119     //- Runtime type information
120     TypeName("LienCubicKELowRe");
122     // Constructors
124         //- Construct from components
125         LienCubicKELowRe
126         (
127             const volVectorField& U,
128             const surfaceScalarField& phi,
129             transportModel& transport
130         );
133     //- Destructor
135         virtual ~LienCubicKELowRe()
136         {}
139     // Member Functions
141         //- Return the turbulence viscosity
142         virtual tmp<volScalarField> nut() const
143         {
144             return nut_;
145         }
147         //- Return the effective diffusivity for k
148         tmp<volScalarField> DkEff() const
149         {
150             return tmp<volScalarField>
151             (
152                 new volScalarField("DkEff", nut_/sigmak_ + nu())
153             );
154         }
156         //- Return the effective diffusivity for epsilon
157         tmp<volScalarField> DepsilonEff() const
158         {
159             return tmp<volScalarField>
160             (
161                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
162             );
163         }
165         //- Return the turbulence kinetic energy
166         virtual tmp<volScalarField> k() const
167         {
168             return k_;
169         }
171         //- Return the turbulence kinetic energy dissipation rate
172         virtual tmp<volScalarField> epsilon() const
173         {
174             return epsilon_;
175         }
177         //- Return the Reynolds stress tensor
178         virtual tmp<volSymmTensorField> R() const;
180         //- Return the effective stress tensor including the laminar stress
181         virtual tmp<volSymmTensorField> devReff() const;
183         //- Return the source term for the momentum equation
184         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
186         //- Solve the turbulence equations and correct the turbulence viscosity
187         virtual void correct();
189         //- Read RASProperties dictionary
190         virtual bool read();
194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
196 } // End namespace RASModels
197 } // Edn namespace incompressible
198 } // End namespace Foam
200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
202 #endif
204 // ************************************************************************* //