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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::incompressible::RASModels::laminar
  27
  28 Description
  29     Dummy turbulence model for laminar incompressible flow.
  30
  31 SourceFiles
  32     laminar.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef laminar_H
  37 #define laminar_H
  38
  39 #include "RASModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace incompressible
  46 {
  47 namespace RASModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class laminar Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class laminar
  55 :
  56     public RASModel
  57 {
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName("laminar");
  63
  64     // Constructors
  65
  66         //- from components
  67         laminar
  68         (
  69             const volVectorField& U,
  70             const surfaceScalarField& phi,
  71             transportModel& transport
  72         );
  73
  74
  75     // Destructor
  76
  77         ~laminar()
  78         {}
  79
  80
  81     // Member Functions
  82
  83         //- Return the turbulence viscosity, i.e. 0 for laminar flow
  84         tmp<volScalarField> nut() const;
  85
  86         //- Return the effective viscosity, i.e. the laminar viscosity
  87         tmp<volScalarField> nuEff() const;
  88
  89         //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
  90         tmp<volScalarField> k() const;
  91
  92         //- Return the turbulence kinetic energy dissipation rate,
  93         //  i.e. 0 for laminar flow
  94         tmp<volScalarField> epsilon() const;
  95
  96         //- Return the Reynolds stress tensor, i.e. 0 for laminar flow
  97         tmp<volSymmTensorField> R() const;
  98
  99         //- Return the effective stress tensor including the laminar stress
 100         tmp<volSymmTensorField> devReff() const;
 101
 102         //- Return the source term for the momentum equation
 103         tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 104
 105         //- Correct the laminar viscosity
 106         void correct();
 107
 108         //- Read turbulenceProperties dictionary
 109         bool read();
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace RASModels
 116 } // End namespace incompressible
 117 } // End namespace Foam
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #endif
 122
 123 // ************************************************************************* //