OpenFOAM logo
Open Source CFD Toolkit

thermophysicalFunction.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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     
00027 Description
00028     Abstract base class for thermo-physical functions
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef thermophysicalFunction_H
00033 #define thermophysicalFunction_H
00034 
00035 #include "scalar.H"
00036 #include "IOstreams.H"
00037 #include "typeInfo.H"
00038 #include "autoPtr.H"
00039 #include "runTimeSelectionTables.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class thermophysicalFunction Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class thermophysicalFunction
00051 {
00052 
00053 public:
00054 
00055     //- Runtime type information
00056     TypeName("thermophysicalFunction");
00057 
00058 
00059     // Declare run-time constructor selection tables
00060 
00061         declareRunTimeSelectionTable
00062         (
00063             autoPtr,
00064             thermophysicalFunction,
00065             Istream,
00066             (Istream& is),
00067             (is)
00068         );
00069 
00070 
00071     // Constructors
00072 
00073         //- Construct null
00074         thermophysicalFunction()
00075         {}
00076 
00077         //- Return a pointer to a new thermophysicalFunction created from input
00078         static autoPtr<thermophysicalFunction> New(Istream& is);
00079 
00080 
00081     // Destructor
00082 
00083         virtual ~thermophysicalFunction()
00084         {}
00085 
00086 
00087     // Member Functions
00088 
00089         //- Evaluate the function and return the result
00090         virtual scalar f(scalar p, scalar T) const = 0;
00091 
00092         //- Write the function coefficients
00093         virtual void writeData(Ostream& os) const = 0;
00094 
00095 
00096     // Ostream Operator
00097 
00098         friend Ostream& operator<<(Ostream& os, const thermophysicalFunction& f)
00099         {
00100             f.writeData(os);
00101             return os;
00102         }
00103 };
00104 
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 } // End namespace Foam
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 #endif
00113 
00114 // ************************************************************************* //
For further information go to www.openfoam.org