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

csvTableReader.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::cvsTableReader
00026 
00027 Description
00028     Reads an interpolation table from a file - CSV-format
00029 
00030 SourceFiles
00031     cvsTableReader.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef csvTableReader_H
00036 #define csvTableReader_H
00037 
00038 #include <OpenFOAM/tableReader.H>
00039 #include <OpenFOAM/labelList.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class csvTableReader Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class Type>
00051 class csvTableReader
00052 :
00053     public tableReader<Type>
00054 {
00055     //- does the file have a header line?
00056     const bool headerLine_;
00057 
00058     //- column of the time
00059     const label timeColumn_;
00060 
00061     //- labels of the components
00062     const labelList componentColumns_;
00063 
00064     //- read the next value from the splitted string
00065     Type readValue(const List<string>&);
00066 
00067     //- separator character
00068     const char separator_;
00069 
00070 public:
00071 
00072     //- Runtime type information
00073     TypeName("csv");
00074 
00075     // Constructors
00076 
00077         //- Construct from dictionary
00078         csvTableReader(const dictionary& dict);
00079 
00080         //- Construct and return a copy
00081         virtual autoPtr<tableReader<Type> > clone() const
00082         {
00083             return autoPtr<tableReader<Type> >
00084             (
00085                 new csvTableReader<Type>
00086                 (
00087                     *this
00088                 )
00089             );
00090         }
00091 
00092 
00093     //- Destructor
00094 
00095         virtual ~csvTableReader();
00096 
00097 
00098     // Member Functions
00099 
00100         //- Read the table
00101         virtual void operator()(const fileName&, List<Tuple2<scalar, Type> >&);
00102 
00103         //- write the remaining parameters
00104         virtual void write(Ostream& os) const;
00105 
00106 };
00107 
00108 
00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00110 
00111 } // End namespace Foam
00112 
00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00114 
00115 #ifdef NoRepository
00116 #   include "csvTableReader.C"
00117 #endif
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines