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