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) 2011-2016 OpenFOAM Foundation
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 "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 
61  // Constructors
62 
63  //- Construct from dictionary
65 
66  //- Construct and return a copy
67  virtual autoPtr<tableReader<Type>> clone() const
68  {
70  (
72  (
73  *this
74  )
75  );
76  }
77 
78 
79  //- Destructor
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  //- Read 2D table
89  virtual void operator()
90  (
91  const fileName&,
93  );
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104  #include "openFoamTableReader.C"
105 #endif
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
virtual void operator()(const fileName &, List< Tuple2< scalar, Type >> &)
Read the table.
dictionary dict
A class for handling file names.
Definition: fileName.H:69
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A 2-tuple for storing two objects of different types.
Definition: HashTable.H:66
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:60
Reads an interpolation table from a file - OpenFOAM-format.
Base class to read table data for the interpolationTable.
Definition: tableReader.H:57
virtual autoPtr< tableReader< Type > > clone() const
Construct and return a copy.
openFoamTableReader(const dictionary &dict)
Construct from dictionary.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
TypeName("openFoam")
Runtime type information.
virtual ~openFoamTableReader()
Destructor.
Namespace for OpenFOAM.