src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  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.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::incompressible::RASModels::LienCubicKELowRe
  27
  28 Description
  29     Lien cubic non-linear low-Reynolds k-epsilon turbulence models for
  30     incompressible flows.
  31
  32     References:
  33     @verbatim
  34         Lien, F.S., Chen, W.L., Leschziner, M.A.,
  35         "Low-Reynolds-number eddy-viscosity modeling based on non-linear
  36          stress-strain/vorticity relations"
  37         Engineering Turbulence Modelling and Experiments 3
  38         (Edited by Rodi, W. and Bergeles, G.), 91-100. 1996.
  39         Elsevier Science Publishers.
  40
  41         Etemad, S., et al.,
  42         "Turbulent flow and heat transfer in a square-sectioned U bend"
  43         Progress in compuational fluid dynamics 6, 89-100. 2006.
  44     @endverbatim
  45
  46 SourceFiles
  47     LienCubicKELowRe.C
  48
  49 \*---------------------------------------------------------------------------*/
  50
  51 #ifndef LienCubicKELowRe_H
  52 #define LienCubicKELowRe_H
  53
  54 #include "RASModel.H"
  55 #include "wallDist.H"
  56
  57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  58
  59 namespace Foam
  60 {
  61 namespace incompressible
  62 {
  63 namespace RASModels
  64 {
  65
  66 /*---------------------------------------------------------------------------*\
  67                            Class LienCubicKELowRe Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class LienCubicKELowRe
  71 :
  72     public RASModel
  73 {
  74     // Private data
  75
  76         // Model coefficients
  77
  78             dimensionedScalar C1_;
  79             dimensionedScalar C2_;
  80             dimensionedScalar sigmak_;
  81             dimensionedScalar sigmaEps_;
  82             dimensionedScalar A1_;
  83             dimensionedScalar A2_;
  84             dimensionedScalar Ctau1_;
  85             dimensionedScalar Ctau2_;
  86             dimensionedScalar Ctau3_;
  87             dimensionedScalar alphaKsi_;
  88
  89             dimensionedScalar CmuWall_;
  90             dimensionedScalar kappa_;
  91
  92             dimensionedScalar Am_;
  93             dimensionedScalar Aepsilon_;
  94             dimensionedScalar Amu_;
  95
  96
  97         // Fields
  98
  99             volScalarField k_;
 100             volScalarField epsilon_;
 101
 102             wallDist y_;
 103
 104             volTensorField gradU_;
 105             volScalarField eta_;
 106             volScalarField ksi_;
 107             volScalarField Cmu_;
 108             volScalarField fEta_;
 109             volScalarField C5viscosity_;
 110
 111             volScalarField yStar_;
 112
 113             volScalarField nut_;
 114
 115             volSymmTensorField nonlinearStress_;
 116
 117
 118 public:
 119
 120     //- Runtime type information
 121     TypeName("LienCubicKELowRe");
 122
 123     // Constructors
 124
 125         //- Construct from components
 126         LienCubicKELowRe
 127         (
 128             const volVectorField& U,
 129             const surfaceScalarField& phi,
 130             transportModel& transport
 131         );
 132
 133
 134     //- Destructor
 135     virtual ~LienCubicKELowRe()
 136     {}
 137
 138
 139     // Member Functions
 140
 141         //- Return the turbulence viscosity
 142         virtual tmp<volScalarField> nut() const
 143         {
 144             return nut_;
 145         }
 146
 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         }
 155
 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         }
 164
 165         //- Return the turbulence kinetic energy
 166         virtual tmp<volScalarField> k() const
 167         {
 168             return k_;
 169         }
 170
 171         //- Return the turbulence kinetic energy dissipation rate
 172         virtual tmp<volScalarField> epsilon() const
 173         {
 174             return epsilon_;
 175         }
 176
 177         //- Return the Reynolds stress tensor
 178         virtual tmp<volSymmTensorField> R() const;
 179
 180         //- Return the effective stress tensor including the laminar stress
 181         virtual tmp<volSymmTensorField> devReff() const;
 182
 183         //- Return the source term for the momentum equation
 184         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 185
 186         //- Solve the turbulence equations and correct the turbulence viscosity
 187         virtual void correct();
 188
 189         //- Read RASProperties dictionary
 190         virtual bool read();
 191 };
 192
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 } // End namespace RASModels
 197 } // Edn namespace incompressible
 198 } // End namespace Foam
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #endif
 203
 204 // ************************************************************************* //