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

heatTransferModel.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::heatTransferModel
00026 
00027 Description
00028     Foam::heatTransferModel
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef heatTransferModel_H
00033 #define heatTransferModel_H
00034 
00035 #include <OpenFOAM/IOdictionary.H>
00036 #include <OpenFOAM/autoPtr.H>
00037 #include <OpenFOAM/runTimeSelectionTables.H>
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class heatTransferModel Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 class heatTransferModel
00049 
00050 {
00051 
00052 protected:
00053 
00054     // Protected data
00055 
00056     const dictionary& dict_;
00057 
00058 public:
00059 
00060     //- Runtime type information
00061         TypeName("heatTransferModel");
00062 
00063 
00064     // Declare runtime constructor selection table
00065 
00066         declareRunTimeSelectionTable
00067         (
00068             autoPtr,
00069             heatTransferModel,
00070             dictionary,
00071             (
00072                 const dictionary& dict
00073             ),
00074             (dict)
00075         );
00076 
00077 
00078     // Constructors
00079 
00080         //- Construct from dictionary
00081         heatTransferModel
00082         (
00083             const dictionary& dict
00084         );
00085 
00086 
00087     // Destructor
00088 
00089         virtual ~heatTransferModel();
00090 
00091 
00092     // Selector
00093 
00094         static autoPtr<heatTransferModel> New
00095         (
00096             const dictionary& dict
00097         );
00098 
00099 
00100     // Member Functions
00101 
00102         //- heat transfer on/off
00103         virtual bool heatTransfer() const = 0;
00104 
00105         //- Return Nusselt Number
00106         virtual scalar Nu
00107         (
00108             const scalar ReynoldsNumber,
00109             const scalar PrandtlNumber
00110         ) const = 0;
00111 
00112         //- Return the heat transfer relaxation time
00113         virtual scalar relaxationTime
00114         (
00115             const scalar liquidDensity,
00116             const scalar diameter,
00117             const scalar liquidcL,
00118             const scalar kappa,
00119             const scalar ReynoldsNumber,
00120             const scalar PrandtlNumber
00121         ) const = 0;
00122 
00123         //- Return the correction function f...
00124         virtual scalar fCorrection(const scalar z) const = 0;
00125 
00126 };
00127 
00128 
00129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00130 
00131 } // End namespace Foam
00132 
00133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00134 
00135 #endif
00136 
00137 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines