Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / turbulenceModels / incompressible / RAS / LamBremhorstKE / LamBremhorstKE.H
blob386e24c946b30f45a8246bced910d5d9695a4383
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::LamBremhorstKE
27 Description
28     Lam and Bremhorst low-Reynolds number k-epsilon turbulence model
29     for incompressible flows
31 SourceFiles
32     LamBremhorstKE.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef LamBremhorstKE_H
37 #define LamBremhorstKE_H
39 #include "RASModel.H"
40 #include "wallDist.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace incompressible
48 namespace RASModels
51 /*---------------------------------------------------------------------------*\
52                       Class LamBremhorstKE Declaration
53 \*---------------------------------------------------------------------------*/
55 class LamBremhorstKE
57     public RASModel
59     // Private data
61         dimensionedScalar Cmu_;
62         dimensionedScalar C1_;
63         dimensionedScalar C2_;
64         dimensionedScalar sigmaEps_;
66         volScalarField k_;
67         volScalarField epsilon_;
69         wallDist y_;
70         volScalarField Rt_;
72         volScalarField fMu_;
73         volScalarField nut_;
76 public:
78     //- Runtime type information
79     TypeName("LamBremhorstKE");
82     // Constructors
84         //- Construct from components
85         LamBremhorstKE
86         (
87             const volVectorField& U,
88             const surfaceScalarField& phi,
89             transportModel& transport
90         );
93     //- Destructor
95         virtual ~LamBremhorstKE()
96         {}
99     // Member Functions
101         //- Return the turbulence viscosity
102         virtual tmp<volScalarField> nut() const
103         {
104             return nut_;
105         }
107         //- Return the effective diffusivity for k
108         tmp<volScalarField> DkEff() const
109         {
110             return tmp<volScalarField>
111             (
112                 new volScalarField("DkEff", nut_ + nu())
113             );
114         }
116         //- Return the effective diffusivity for epsilon
117         tmp<volScalarField> DepsilonEff() const
118         {
119             return tmp<volScalarField>
120             (
121                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
122             );
123         }
125         //- Return the turbulence kinetic energy
126         virtual tmp<volScalarField> k() const
127         {
128             return k_;
129         }
131         //- Return the turbulence kinetic energy dissipation rate
132         virtual tmp<volScalarField> epsilon() const
133         {
134             return epsilon_;
135         }
137         //- Return the Reynolds stress tensor
138         virtual tmp<volSymmTensorField> R() const;
140         //- Return the effective stress tensor including the laminar stress
141         virtual tmp<volSymmTensorField> devReff() const;
143         //- Return the source term for the momentum equation
144         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
146         //- Solve the turbulence equations and correct the turbulence viscosity
147         virtual void correct();
149         //- Read RASProperties dictionary
150         virtual bool read();
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 } // End namespace RASModels
157 } // End namespace incompressible
158 } // End namespace Foam
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 #endif
164 // ************************************************************************* //