src/transportModels/incompressible/singlePhaseTransportModel/singlePhaseTransportModel.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::singlePhaseTransportModel
  26
  27 Description
  28     A simple single-phase transport model based on viscosityModel.
  29
  30     Used by the incompressible single-phase solvers like simpleFoam,
  31     turbFoam etc.
  32
  33 SourceFiles
  34     singlePhaseTransportModel.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef singlePhaseTransportModel_H
  39 #define singlePhaseTransportModel_H
  40
  41 #include "incompressible/transportModel/transportModel.H"
  42 #include "autoPtr.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 class viscosityModel;
  50
  51 /*---------------------------------------------------------------------------*\
  52                 Class singlePhaseTransportModel Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class singlePhaseTransportModel
  56 :
  57     public transportModel
  58 {
  59     // Private Data
  60
  61         autoPtr<viscosityModel> viscosityModelPtr_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow copy construct
  67         singlePhaseTransportModel(const singlePhaseTransportModel&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const singlePhaseTransportModel&);
  71
  72
  73 public:
  74
  75     // Constructors
  76
  77         //- Construct from components
  78         singlePhaseTransportModel
  79         (
  80             const volVectorField& U,
  81             const surfaceScalarField& phi
  82         );
  83
  84
  85     // Destructor
  86
  87         virtual ~singlePhaseTransportModel();
  88
  89
  90     // Member Functions
  91
  92         //- Return the laminar viscosity
  93         virtual const volScalarField& nu() const;
  94
  95         //- Correct the laminar viscosity
  96         virtual void correct();
  97
  98         //- Read transportProperties dictionary
  99         virtual bool read();
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //