src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.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::LienCubicKE
  27
  28 Description
  29     Lien cubic non-linear k-epsilon turbulence model for incompressible flows.
  30
  31 SourceFiles
  32     LienCubicKE.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef LienCubicKE_H
  37 #define LienCubicKE_H
  38
  39 #include "RASModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace incompressible
  46 {
  47 namespace RASModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class LienCubicKE Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class LienCubicKE
  55 :
  56     public RASModel
  57 {
  58     // Private data
  59
  60         // Model coefficients
  61
  62             dimensionedScalar C1_;
  63             dimensionedScalar C2_;
  64             dimensionedScalar sigmak_;
  65             dimensionedScalar sigmaEps_;
  66             dimensionedScalar A1_;
  67             dimensionedScalar A2_;
  68             dimensionedScalar Ctau1_;
  69             dimensionedScalar Ctau2_;
  70             dimensionedScalar Ctau3_;
  71             dimensionedScalar alphaKsi_;
  72
  73
  74         // Fields
  75
  76             volScalarField k_;
  77             volScalarField epsilon_;
  78
  79             volTensorField gradU_;
  80             volScalarField eta_;
  81             volScalarField ksi_;
  82             volScalarField Cmu_;
  83             volScalarField fEta_;
  84             volScalarField C5viscosity_;
  85
  86             volScalarField nut_;
  87
  88             volSymmTensorField nonlinearStress_;
  89
  90
  91 public:
  92
  93     //- Runtime type information
  94     TypeName("LienCubicKE");
  95
  96     // Constructors
  97
  98         //- Construct from components
  99         LienCubicKE
 100         (
 101             const volVectorField& U,
 102             const surfaceScalarField& phi,
 103             transportModel& transport
 104         );
 105
 106
 107     // Destructor
 108     virtual ~LienCubicKE()
 109     {}
 110
 111
 112     // Member Functions
 113
 114         //- Return the turbulence viscosity
 115         virtual tmp<volScalarField> nut() const
 116         {
 117             return nut_;
 118         }
 119
 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         }
 128
 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         }
 137
 138         //- Return the turbulence kinetic energy
 139         virtual tmp<volScalarField> k() const
 140         {
 141             return k_;
 142         }
 143
 144         //- Return the turbulence kinetic energy dissipation rate
 145         virtual tmp<volScalarField> epsilon() const
 146         {
 147             return epsilon_;
 148         }
 149
 150         //- Return the Reynolds stress tensor
 151         virtual tmp<volSymmTensorField> R() const;
 152
 153         //- Return the effective stress tensor including the laminar stress
 154         virtual tmp<volSymmTensorField> devReff() const;
 155
 156         //- Return the source term for the momentum equation
 157         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 158
 159         //- Solve the turbulence equations and correct the turbulence viscosity
 160         virtual void correct();
 161
 162         //- Read RASProperties dictionary
 163         virtual bool read();
 164 };
 165
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 } // End namespace RASModels
 170 } // End namespace incompressible
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #endif
 176
 177 // ************************************************************************* //