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