FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

transportModel.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::transportModel
00026 
00027 Description
00028     Base-class for all transport models used by the incompressible turbulence
00029     models.
00030 
00031 SourceFiles
00032     transportModel.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef transportModel_H
00037 #define transportModel_H
00038 
00039 #include <OpenFOAM/IOdictionary.H>
00040 #include <finiteVolume/volFieldsFwd.H>
00041 #include <finiteVolume/surfaceFieldsFwd.H>
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                 Class transportModel Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class transportModel
00053 :
00054     public IOdictionary
00055 {
00056     // Private Member Functions
00057 
00058         //- Disallow copy construct
00059         transportModel(const transportModel&);
00060 
00061         //- Disallow default bitwise assignment
00062         void operator=(const transportModel&);
00063 
00064 
00065 public:
00066 
00067     // Constructors
00068 
00069         //- Construct from components
00070         transportModel
00071         (
00072             const volVectorField& U,
00073             const surfaceScalarField& phi
00074         );
00075 
00076 
00077     // Destructor
00078 
00079         virtual ~transportModel();
00080 
00081 
00082     // Member Functions
00083 
00084         //- Return the laminar viscosity
00085         virtual tmp<volScalarField> nu() const = 0;
00086 
00087         //- Correct the laminar viscosity
00088         virtual void correct() = 0;
00089 
00090         //- Read transportProperties dictionary
00091         virtual bool read() = 0;
00092 };
00093 
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 } // End namespace Foam
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 #endif
00102 
00103 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines