File size: 7,314 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::Function1s::Table
Description
Templated interpolated tabulated data Function1.
Items are stored in a list of Tuple2's. First column is always stored as
scalar entries. Data is read in Tuple2 form:
Usage
\verbatim
<name> table
(
(0.0 (1 2 3))
(1.0 (4 5 6))
);
\endverbatim
or in dictionary form which supports the setting of options, e.g.
\verbatim
<name> table;
values
(
(0.0 (1 2 3))
(1.0 (4 5 6))
);
outOfBounds clamp; // optional out-of-bounds handling
interpolationScheme linear; // optional interpolation method
\endverbatim
or in sub-dictionary form which avoids clashes between table entries and
other entries in the dictionary:
\verbatim
<name>
{
type table;
values
(
(0.0 (1 2 3))
(1.0 (4 5 6))
);
outOfBounds clamp; // optional out-of-bounds handling
interpolationScheme linear; // optional interpolation method
}
\endverbatim
The data may be read from a separate file in either native or CSV format:
\verbatim
<name>
{
type table;
file "<file path>"; // Name/path of thedata file
format foam; // data format (optional)
outOfBounds clamp; // optional out-of-bounds handling
interpolationScheme linear; // optional interpolation method
}
\endverbatim
SourceFiles
Table.C
See also
FoamTableReader.C
CsvTableReader.C
\*---------------------------------------------------------------------------*/
#ifndef Table_H
#define Table_H
#include "tableBase.H"
#include "Function1.H"
#include "TableReader.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class interpolationWeights;
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class Table Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Table
:
public tableBase,
public FieldFunction1<Type, Table<Type>>
{
// Private Data
//- Enumeration for handling out-of-bound values
const tableBase::boundsHandling boundsHandling_;
//- Interpolation scheme
const word interpolationScheme_;
//- Table reader
const autoPtr<TableReader<scalar, Type>> reader_;
//- Table data
const List<Tuple2<scalar, Type>> values_;
//- Extracted values
mutable autoPtr<scalarField> tableSamplesPtr_;
//- Interpolator method
mutable autoPtr<interpolationWeights> interpolatorPtr_;
//- Cached indices
mutable labelList indices_;
//- Cached weights
mutable scalarField weights_;
// Private Member Functions
//- Return (demand driven) interpolator
const interpolationWeights& interpolator() const;
//- Check the table for size and consistency
void check() const;
//- Check the validity of a given argument value
void checkX(const scalar x) const;
public:
//- Runtime type information
TypeName("table");
// Constructors
//- Construct from components
Table
(
const word& name,
const tableBase::boundsHandling boundsHandling,
const word& interpolationScheme,
const autoPtr<TableReader<scalar, Type>>& reader,
const List<Tuple2<scalar, Type>>& table
);
//- Construct from name and dictionary
Table
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Construct from name and dictionary
Table
(
const word& name,
const unitSet& xUnits,
const unitSet& valueUnits,
const dictionary& dict
);
//- Construct from name and Istream
Table
(
const word& name,
const unitSets& units,
Istream& dict
);
//- Copy constructor
Table(const Table<Type>& tbl);
//- Destructor
virtual ~Table();
// Member Functions
//- Return the handling out-of-bound values
const tableBase::boundsHandling& boundsHandling() const
{
return boundsHandling_;
}
//- Return the interpolation scheme
const word& interpolationScheme() const
{
return interpolationScheme_;
}
//- Return table data
const List<Tuple2<scalar, Type>>& values() const
{
return values_;
}
//- Return the value at a scalar coordinate
virtual Type value(const scalar x) const;
//- Return the derivative at a scalar coordinate
virtual Type derivative(const scalar x) const;
//- Return the integral between two scalar coordinates
virtual Type integral(const scalar x1, const scalar x2) const;
//- Return the reference values
virtual tmp<scalarField> x() const;
//- Return the dependent values
virtual tmp<Field<Type>> y() const;
//- Write in dictionary format
virtual void write(Ostream& os, const unitSets& units) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const Table<Type>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "Table.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|