FreeFOAM The Cross-Platform CFD Toolkit
openFoamTableReader.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2011 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::openFoamTableReader
26 
27 Description
28  Reads an interpolation table from a file - OpenFOAM-format
29 
30 SourceFiles
31  openFoamTableReader.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef openFoamTableReader_H
36 #define openFoamTableReader_H
37 
38 #include <OpenFOAM/tableReader.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class openFoamTableReader Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
51 :
52  public tableReader<Type>
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("openFoam");
59 
60  // Constructors
61 
62  //- Construct from dictionary
63  openFoamTableReader(const dictionary &dict);
64 
65  //- Construct and return a copy
66  virtual autoPtr<tableReader<Type> > clone() const
67  {
69  (
71  (
72  *this
73  )
74  );
75  }
76 
77 
78  //- Destructor
79 
80  virtual ~openFoamTableReader();
81 
82 
83  // Member functions
84 
85  //- Read the table
86  virtual void operator()(const fileName&, List<Tuple2<scalar, Type> > &);
87 
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #ifdef NoRepository
98 # include "openFoamTableReader.C"
99 #endif
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************ vim: set sw=4 sts=4 et: ************************ //