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