src/turbulenceModels/incompressible/RAS/laminar/laminar.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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         );
  72
  73
  74     //- Destructor
  75     virtual ~laminar()
  76     {}
  77
  78
  79     // Member Functions
  80
  81         //- Return the turbulence viscosity, i.e. 0 for laminar flow
  82         virtual tmp<volScalarField> nut() const;
  83
  84         //- Return the effective viscosity, i.e. the laminar viscosity
  85         virtual tmp<volScalarField> nuEff() const
  86         {
  87             return tmp<volScalarField>(new volScalarField("nuEff", nu()));
  88         }
  89
  90         //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
  91         virtual tmp<volScalarField> k() const;
  92
  93         //- Return the turbulence kinetic energy dissipation rate,
  94         //  i.e. 0 for laminar flow
  95         virtual tmp<volScalarField> epsilon() const;
  96
  97         //- Return the Reynolds stress tensor, i.e. 0 for laminar flow
  98         virtual tmp<volSymmTensorField> R() const;
  99
 100         //- Return the effective stress tensor, i.e. the laminar stress
 101         virtual tmp<volSymmTensorField> devReff() const;
 102
 103         //- Return the source term for the momentum equation
 104         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 105
 106         //- Correct the laminar viscosity
 107         virtual void correct();
 108
 109         //- Read RASProperties dictionary
 110         virtual bool read();
 111 };
 112
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 } // End namespace RASModels
 117 } // End namespace incompressible
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //