Base class for table with bounds handling, interpolation and integration. More...
Public Member Functions | |
TableBase (const word &name, const dictionary &dict) | |
Construct from dictionary - note table is not populated. More... | |
TableBase (const TableBase< Type > &tbl) | |
Copy constructor. Note: steals interpolator, tableSamples. More... | |
virtual | ~TableBase () |
Destructor. More... | |
void | check () const |
Check the table for size and consistency. More... | |
bool | checkMinBounds (const scalar x, scalar &xDash) const |
Check minimum table bounds. More... | |
bool | checkMaxBounds (const scalar x, scalar &xDash) const |
Check maximum table bounds. More... | |
virtual void | convertTimeBase (const Time &t) |
Convert time. More... | |
virtual Type | value (const scalar x) const |
Return Table value. More... | |
virtual Type | integrate (const scalar x1, const scalar x2) const |
Integrate between two (scalar) values. More... | |
virtual tmp< scalarField > | x () const |
Return the reference values. More... | |
virtual tmp< Field< Type > > | y () const |
Return the dependent values. More... | |
virtual void | writeData (Ostream &os) const |
Write all table data in dictionary format. More... | |
virtual void | writeEntries (Ostream &os) const |
Write keywords only in dictionary format. More... | |
Public Member Functions inherited from Function1< Type > | |
TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
Function1 (const word &entryName) | |
Construct from entry name. More... | |
Function1 (const Function1< Type > &rhs) | |
Copy constructor. More... | |
virtual tmp< Function1< Type > > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~Function1 ()=default |
Destructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
virtual tmp< Field< Type > > | value (const scalarField &x) const |
Return value as a function of (scalar) independent variable. More... | |
virtual tmp< Field< Type > > | integrate (const scalarField &x1, const scalarField &x2) const |
Integrate between two (scalar) values. More... | |
Protected Member Functions | |
const interpolationWeights & | interpolator () const |
Return (demand driven) interpolator. More... | |
void | operator= (const TableBase< Type > &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from Function1< Type > | |
void | operator= (const Function1< Type > &)=delete |
No copy assignment. More... | |
Protected Attributes | |
const word | name_ |
Table name. More... | |
const bounds::repeatableBounding | bounding_ |
Handling for out-of-bound values. More... | |
const word | interpolationScheme_ |
Interpolation type. More... | |
List< Tuple2< scalar, Type > > | table_ |
Table data. More... | |
autoPtr< scalarField > | tableSamplesPtr_ |
Extracted values. More... | |
autoPtr< interpolationWeights > | interpolatorPtr_ |
Interpolator method. More... | |
labelList | currentIndices_ |
Cached indices and weights. More... | |
scalarField | currentWeights_ |
Protected Attributes inherited from Function1< Type > | |
const word | name_ |
Name of entry. More... | |
Additional Inherited Members | |
Public Types inherited from Function1< Type > | |
typedef Type | returnType |
Static Public Member Functions inherited from Function1< Type > | |
static autoPtr< Function1< Type > > | New (const word &entryName, const dictionary &dict, const word &redirectType=word::null) |
Selector. More... | |
Public Attributes inherited from Function1< Type > | |
Function1 | |
dictionary | |
const word & | entryName |
const word const dictionary & | dict |
const word const dictionary | entryName |
const word const dictionary | dict |
Base class for table with bounds handling, interpolation and integration.
Definition at line 59 of file TableBase.H.
TableBase | ( | const word & | name, |
const dictionary & | dict | ||
) |
Construct from dictionary - note table is not populated.
Definition at line 63 of file TableBase.C.
Copy constructor. Note: steals interpolator, tableSamples.
Definition at line 91 of file TableBase.C.
|
virtual |
Destructor.
Definition at line 106 of file TableBase.C.
|
protected |
Return (demand driven) interpolator.
Definition at line 37 of file TableBase.C.
References forAll, Foam::New(), and samples().
void check | ( | ) | const |
Check the table for size and consistency.
Definition at line 113 of file TableBase.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
bool checkMinBounds | ( | const scalar | x, |
scalar & | xDash | ||
) | const |
Check minimum table bounds.
Definition at line 145 of file TableBase.C.
References Foam::bounds::CLAMP, Foam::endl(), Foam::bounds::ERROR, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, Foam::bounds::REPEAT, Foam::bounds::WARN, WarningInFunction, and x.
bool checkMaxBounds | ( | const scalar | x, |
scalar & | xDash | ||
) | const |
Check maximum table bounds.
Definition at line 203 of file TableBase.C.
References Foam::bounds::CLAMP, Foam::endl(), Foam::bounds::ERROR, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, Foam::bounds::REPEAT, Foam::bounds::WARN, WarningInFunction, and x.
|
virtual |
Convert time.
Reimplemented from Function1< Type >.
Definition at line 260 of file TableBase.C.
References TimeState::userTimeToTime().
|
virtual |
Return Table value.
Reimplemented from Function1< Type >.
Definition at line 273 of file TableBase.C.
References x.
|
virtual |
Integrate between two (scalar) values.
Reimplemented from Function1< Type >.
Definition at line 302 of file TableBase.C.
References Foam::sum().
|
virtual |
Return the reference values.
Definition at line 321 of file TableBase.C.
References fld, forAll, tmp< T >::New(), and Foam::Zero.
|
virtual |
Return the dependent values.
Definition at line 336 of file TableBase.C.
References fld, forAll, Foam::New(), and Foam::Zero.
|
virtual |
Write all table data in dictionary format.
Reimplemented from Function1< Type >.
Reimplemented in CSV< Type >, and TableFile< Type >.
Definition at line 372 of file TableBase.C.
References token::END_STATEMENT, Foam::indent(), Foam::nl, and Function1< Type >::writeData().
|
virtual |
Write keywords only in dictionary format.
Used for non-inline table types
Definition at line 351 of file TableBase.C.
References Foam::bounds::CLAMP, Foam::bounds::repeatableBoundingNames, Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().
Referenced by TableFile< Type >::writeData(), and CSV< Type >::writeData().
|
protected |
Table name.
Definition at line 68 of file TableBase.H.
|
protected |
Handling for out-of-bound values.
Definition at line 71 of file TableBase.H.
|
protected |
Interpolation type.
Definition at line 74 of file TableBase.H.
Table data.
Definition at line 77 of file TableBase.H.
|
mutableprotected |
Extracted values.
Definition at line 80 of file TableBase.H.
|
mutableprotected |
Interpolator method.
Definition at line 83 of file TableBase.H.
|
mutableprotected |
Cached indices and weights.
Definition at line 86 of file TableBase.H.
|
mutableprotected |
Definition at line 88 of file TableBase.H.