FreeFOAM The Cross-Platform CFD Toolkit
Table.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-2010 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::Table
26 
27 Description
28  Templated table container data entry. Items are stored in a list of
29  Tuple2's. First column is always stored as scalar entries. Data is read
30  in the form, e.g. for an entry <entryName> that is (scalar, vector):
31 
32  @verbatim
33  <entryName> table
34  (
35  0.0 (1 2 3)
36  1.0 (4 5 6)
37  );
38  @endverbatim
39 
40 SourceFiles
41  Table.C
42 
43 \*---------------------------------------------------------------------------*/
44 
45 #ifndef Table_H
46 #define Table_H
47 
49 #include <OpenFOAM/Tuple2.H>
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55 
56 template<class Type>
57 class Table;
58 
59 template<class Type>
60 Ostream& operator<<
61 (
62  Ostream&,
63  const Table<Type>&
64 );
65 
66 /*---------------------------------------------------------------------------*\
67  Class Table Declaration
68 \*---------------------------------------------------------------------------*/
69 
70 template<class Type>
71 class Table
72 :
73  public DataEntry<Type>
74 {
75  // Private data
76 
77  //- Table data
79 
80 
81  // Private Member Functions
82 
83  //- Disallow default bitwise assignment
84  void operator=(const Table<Type>&);
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("table");
91 
92 
93  // Constructors
94 
95  //- Construct from entry name and Istream
96  Table(const word& entryName, Istream& is);
97 
98  //- Copy constructor
99  Table(const Table<Type>& tbl);
100 
101 
102  //- Destructor
103  virtual ~Table();
104 
105 
106  // Member Functions
107 
108  //- Return Table value
109  Type value(const scalar x) const;
110 
111  //- Integrate between two (scalar) values
112  Type integrate(const scalar x1, const scalar x2) const;
113 
114 
115  //- Ostream Operator
116  friend Ostream& operator<< <Type>
117  (
118  Ostream&,
119  const Constant<Type>&
120  );
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #ifdef NoRepository
132 #endif
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************ vim: set sw=4 sts=4 et: ************************ //