EmbeddedTableReader.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2020 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::TableReaders::Embedded
26 
27 Description
28  Reads an interpolation table from the \c values entry in OpenFOAM-format.
29 
30  This is a list of Tuple2's where the first (x) column is scalar, and the
31  second (y) column is the type to be interpolated.
32 
33  Usage:
34  \verbatim
35  values
36  (
37  (0.0 (1 2 3))
38  (1.0 (4 5 6))
39  );
40  \endverbatim
41 
42 SourceFiles
43  Embedded.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef EmbeddedTableReader_H
48 #define EmbeddedTableReader_H
49 
50 #include "TableReader.H"
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 namespace TableReaders
57 {
58 
59 /*---------------------------------------------------------------------------*\
60  Class Foam Declaration
61 \*---------------------------------------------------------------------------*/
62 
63 template<class Type>
64 class Embedded
65 :
66  public TableReader<Type>
67 {
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("embedded");
73 
74 
75  // Constructors
76 
77  //- Construct from dictionary
78  Embedded
79  (
80  const word& name,
81  const dictionary &dict,
83  );
84 
85  //- Construct and return a copy
86  virtual autoPtr<TableReader<Type>> clone() const
87  {
88  return autoPtr<TableReader<Type>>(new Embedded<Type>(*this));
89  }
90 
91 
92  //- Destructor
93  virtual ~Embedded();
94 
95 
96  // Member Functions
97 
98  //- Write the table values
99  virtual void write
100  (
101  Ostream& os,
102  const List<Tuple2<scalar, Type>>& table
103  ) const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace TableReaders
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #ifdef NoRepository
115  #include "EmbeddedTableReader.C"
116 #endif
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
virtual ~Embedded()
Destructor.
Base class to read table data for tables.
Definition: TableReader.H:49
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A 2-tuple for storing two objects of different types.
Definition: HashTable.H:65
TypeName("embedded")
Runtime type information.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
virtual autoPtr< TableReader< Type > > clone() const
Construct and return a copy.
Reads an interpolation table from the values entry in OpenFOAM-format.
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
Embedded(const word &name, const dictionary &dict, List< Tuple2< scalar, Type >> &table)
Construct from dictionary.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
virtual void write(Ostream &os, const List< Tuple2< scalar, Type >> &table) const
Write the table values.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Namespace for OpenFOAM.