Table.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29#include "Table.H"
30
31// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32
33template<class Type>
35(
36 const word& entryName,
37 const dictionary& dict,
38 const objectRegistry* obrPtr
39)
40:
41 TableBase<Type>(entryName, dict, obrPtr),
42 fName_()
43{
44 const entry* eptr = dict.findEntry(entryName, keyType::LITERAL);
45
46 if (eptr && eptr->isStream())
47 {
48 // Primitive (inline) format. Eg,
49 // key table ((0 0) (10 1));
50
51 ITstream& is = eptr->stream();
52 if (is.peek().isWord())
53 {
54 is.skip(); // Discard leading 'table'
55 }
56 is >> this->table_;
57 dict.checkITstream(is, entryName);
58 }
59 else if (dict.readIfPresent("file", fName_))
60 {
61 // Dictionary format - "file" lookup. Eg,
62 // key { type table; file "name"; }
63
64 fileName expandedFile(fName_);
65 expandedFile.expand();
66
67 autoPtr<ISstream> isPtr(fileHandler().NewIFstream(expandedFile));
68 if (isPtr && isPtr->good())
69 {
70 *isPtr >> this->table_;
71 }
72 else
73 {
75 << "Cannot open file: " << expandedFile << nl
77 }
78 }
79 else
80 {
81 // Dictionary format - "values" lookup. Eg,
82 //
83 // key { type table; values ((0 0) (10 1)); }
84
85 dict.readEntry("values", this->table_);
86 }
87
89}
90
91
92template<class Type>
94:
95 TableBase<Type>(tbl),
96 fName_(tbl.fName_)
97{}
98
99
100// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
101
102template<class Type>
104{
106 os.endEntry();
107
108 os.beginBlock(word(this->name() + "Coeffs"));
109
110 // Note: for TableBase write the dictionary entries it needs but not
111 // the values themselves
113
114 if (fName_.empty())
115 {
116 os.writeEntry("values", this->table_);
117 }
118 else
119 {
120 os.writeEntry("file", fName_);
121 }
122
123 os.endBlock();
124}
125
126
127// ************************************************************************* //
Base class for table with bounds handling, interpolation and integration.
Definition: TableBase.H:63
void initialise()
Check the table for size and consistency.
Definition: TableBase.C:110
virtual void writeEntries(Ostream &os) const
Write keywords only in dictionary format.
Definition: TableBase.C:348
List< Tuple2< scalar, Type > > table_
Table data.
Definition: TableBase.H:75
Templated table container function.
Definition: Table.H:101
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:96
const word const dictionary & dict
Definition: Function1.H:134
const word & entryName
Definition: Function1.H:133
An input stream of tokens.
Definition: ITstream.H:56
const token & peek() const
Failsafe peek at what the next read would return,.
Definition: ITstream.C:352
void skip(label n=1)
Move tokenIndex relative to the current position.
Definition: ITstream.C:411
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
bool good() const noexcept
True if the managed pointer is non-null.
Definition: autoPtr.H:145
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
void checkITstream(const ITstream &is, const word &keyword) const
Definition: dictionary.C:258
A keyword and a list of tokens is an 'entry'.
Definition: entry.H:70
virtual ITstream & stream() const =0
Return token stream, if entry is a primitive entry.
virtual bool isStream() const noexcept
Return true if this entry is a stream.
Definition: entry.H:223
A class for handling file names.
Definition: fileName.H:76
@ LITERAL
String literal.
Definition: keyType.H:81
Registry of regIOobjects.
string & expand(const bool allowEmpty=false)
Definition: string.C:173
bool isWord() const noexcept
Token is word-variant (WORD, DIRECTIVE)
Definition: tokenI.H:609
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:473
OBJstream os(runTime.globalPath()/outputName)
const fileOperation & fileHandler()
Get current file handler.
IOerror FatalIOError
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
dictionary dict