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