src/turbulenceModels/incompressible/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::incompressible::RASModels::laminar
  26
  27 Description
  28     Dummy turbulence model for laminar incompressible flow.
  29
  30 SourceFiles
  31     laminar.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef rasLaminar_H
  36 #define rasLaminar_H
  37
  38 #include "RASModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace incompressible
  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 volVectorField& U,
  69             const surfaceScalarField& phi,
  70             transportModel& transport,
  71             const word& turbulenceModelName = turbulenceModel::typeName,
  72             const word& modelName = typeName
  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> nut() const;
  85
  86         //- Return the effective viscosity, i.e. the laminar viscosity
  87         virtual tmp<volScalarField> nuEff() const
  88         {
  89             return tmp<volScalarField>(new volScalarField("nuEff", nu()));
  90         }
  91
  92         //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
  93         virtual tmp<volScalarField> k() const;
  94
  95         //- Return the turbulence kinetic energy dissipation rate,
  96         //  i.e. 0 for laminar flow
  97         virtual tmp<volScalarField> epsilon() const;
  98
  99         //- Return the Reynolds stress tensor, i.e. 0 for laminar flow
 100         virtual tmp<volSymmTensorField> R() const;
 101
 102         //- Return the effective stress tensor, i.e. the laminar stress
 103         virtual tmp<volSymmTensorField> devReff() const;
 104
 105         //- Return the source term for the momentum equation
 106         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 107
 108         //- Correct the laminar viscosity
 109         virtual void correct();
 110
 111         //- Read RASProperties dictionary
 112         virtual bool read();
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace RASModels
 119 } // End namespace incompressible
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //