src/turbulenceModels/compressible/RAS/laminar/laminar.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::compressible::RASModels::laminar
  27
  28 Description
  29     Dummy turbulence model for laminar compressible flow.
  30
  31 SourceFiles
  32     laminar.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef compressibleRasLaminar_H
  37 #define compressibleRasLaminar_H
  38
  39 #include "RASModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace compressible
  46 {
  47 namespace RASModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class laminar Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class laminar
  55 :
  56     public RASModel
  57 {
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName("laminar");
  63
  64     // Constructors
  65
  66         //- Construct from components
  67         laminar
  68         (
  69             const volScalarField& rho,
  70             const volVectorField& U,
  71             const surfaceScalarField& phi,
  72             const basicThermo& thermophysicalModel
  73         );
  74
  75
  76     //- Destructor
  77     virtual ~laminar()
  78     {}
  79
  80
  81     // Member Functions
  82
  83         //- Return the turbulence viscosity, i.e. 0 for laminar flow
  84         virtual tmp<volScalarField> mut() const;
  85
  86         //- Return the effective viscosity, i.e. the laminar viscosity
  87         virtual tmp<volScalarField> muEff() const
  88         {
  89             return tmp<volScalarField>(new volScalarField("muEff", mu()));
  90         }
  91
  92         //- Return the effective turbulent thermal diffusivity,
  93         //  i.e. the laminar thermal diffusivity
  94         virtual tmp<volScalarField> alphaEff() const
  95         {
  96             return tmp<volScalarField>(new volScalarField("alphaEff", alpha()));
  97         }
  98
  99         //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
 100         virtual tmp<volScalarField> k() const;
 101
 102         //- Return the turbulence kinetic energy dissipation rate,
 103         //  i.e. 0 for laminar flow
 104         virtual tmp<volScalarField> epsilon() const;
 105
 106         //- Return the Reynolds stress tensor, i.e. 0 for laminar flow
 107         virtual tmp<volSymmTensorField> R() const;
 108
 109         //- Return the effective stress tensor, i.e. the laminar stress
 110         virtual tmp<volSymmTensorField> devRhoReff() const;
 111
 112         //- Return the source term for the momentum equation
 113         virtual tmp<fvVectorMatrix> divDevRhoReff(volVectorField& U) const;
 114
 115         //- Correct the laminar viscosity
 116         virtual void correct();
 117
 118         //- Read RASProperties dictionary
 119         virtual bool read();
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace RASModels
 126 } // End namespace compressible
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************************************************************* //