TableFile.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-2017 OpenFOAM Foundation
9 Copyright (C) 2016-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 "TableFile.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 dict.readEntry("file", fName_);
45
46 fileName expandedFile(fName_);
47
48 autoPtr<ISstream> isPtr(fileHandler().NewIFstream(expandedFile.expand()));
49 ISstream& is = *isPtr;
50
51 if (!is.good())
52 {
54 << "Cannot open file." << nl
56 }
57
58 is >> this->table_;
59
61}
62
63
64template<class Type>
66:
67 TableBase<Type>(tbl),
68 fName_(tbl.fName_)
69{}
70
71
72// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
73
74template<class Type>
76{
78 os.endEntry();
79
80 os.beginBlock(word(this->name() + "Coeffs"));
81
82 // Note: for TableBase write the dictionary entries it needs but not
83 // the values themselves
85
86 os.writeEntry("file", fName_);
87
88 os.endBlock();
89}
90
91
92// ************************************************************************* //
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 where data are read from file.
Definition: TableFile.H:81
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
bool good() const noexcept
True if next operation might succeed.
Definition: IOstream.H:233
Generic input stream using a standard (STL) stream.
Definition: ISstream.H:58
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
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A class for handling file names.
Definition: fileName.H:76
Registry of regIOobjects.
string & expand(const bool allowEmpty=false)
Definition: string.C:173
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