src/turbulenceModels/incompressible/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::incompressible::laminar
  27
  28 Description
  29     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 "turbulenceModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace incompressible
  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 volVectorField& U,
  68             const surfaceScalarField& phi,
  69             transportModel& transport
  70         );
  71
  72
  73     // Selectors
  74
  75         //- Return a reference to the selected turbulence model
  76         static autoPtr<laminar> New
  77         (
  78             const volVectorField& U,
  79             const surfaceScalarField& phi,
  80             transportModel& lamTransportModel
  81         );
  82
  83
  84     //- Destructor
  85     virtual ~laminar()
  86     {}
  87
  88
  89     // Member Functions
  90
  91         //- Return the turbulence viscosity, i.e. 0 for laminar flow
  92         virtual tmp<volScalarField> nut() const;
  93
  94         //- Return the effective viscosity, i.e. the laminar viscosity
  95         virtual tmp<volScalarField> nuEff() const;
  96
  97         //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
  98         virtual tmp<volScalarField> k() const;
  99
 100         //- Return the turbulence kinetic energy dissipation rate,
 101         //  i.e. 0 for laminar flow
 102         virtual tmp<volScalarField> epsilon() const;
 103
 104         //- Return the Reynolds stress tensor, i.e. 0 for laminar flow
 105         virtual tmp<volSymmTensorField> R() const;
 106
 107         //- Return the effective stress tensor, i.e. the laminar stress
 108         virtual tmp<volSymmTensorField> devReff() const;
 109
 110         //- Return the source term for the momentum equation
 111         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 112
 113         //- Correct the laminar viscosity
 114         virtual void correct();
 115
 116         //- Read turbulenceProperties dictionary
 117         virtual bool read();
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace incompressible
 124 } // End namespace Foam
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //