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

openFoamTableReader.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-2011 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::openFoamTableReader
00026 
00027 Description
00028     Reads an interpolation table from a file - OpenFOAM-format
00029 
00030 SourceFiles
00031     openFoamTableReader.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef openFoamTableReader_H
00036 #define openFoamTableReader_H
00037 
00038 #include <OpenFOAM/tableReader.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class openFoamTableReader Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class openFoamTableReader
00051 :
00052     public tableReader<Type>
00053 {
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("openFoam");
00059 
00060     // Constructors
00061 
00062         //- Construct from dictionary
00063         openFoamTableReader(const dictionary &dict);
00064 
00065         //- Construct and return a copy
00066         virtual autoPtr<tableReader<Type> > clone() const
00067         {
00068             return autoPtr<tableReader<Type> >
00069             (
00070                 new openFoamTableReader<Type>
00071                 (
00072                     *this
00073                 )
00074             );
00075         }
00076 
00077 
00078     //- Destructor
00079 
00080         virtual ~openFoamTableReader();
00081 
00082 
00083     // Member functions
00084 
00085         //- Read the table
00086         virtual void operator()(const fileName&, List<Tuple2<scalar, Type> > &);
00087 
00088 };
00089 
00090 
00091 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00092 
00093 } // End namespace Foam
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 #ifdef NoRepository
00098 #   include "openFoamTableReader.C"
00099 #endif
00100 
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 #endif
00105 
00106 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines