Light wrapper around Function1 to provide a mechanism to update time-based entries. More...
Public Member Functions | |
TimeFunction1 (const Time &runTime, const word &name, const dictionary &dict) | |
Construct from entry name and dictionary. More... | |
TimeFunction1 (const Time &runTime, const word &entryName) | |
Construct from entry name. More... | |
TimeFunction1 (const TimeFunction1< Type > &rhs) | |
Copy construct. More... | |
virtual | ~TimeFunction1 ()=default |
Destructor. More... | |
void | reset (const dictionary &dict) |
Reset entry by re-reading from dictionary. More... | |
const word & | name () const |
Return the name of the entry. More... | |
virtual Type | value (const scalar x) const |
Return value as a function of (scalar) independent variable. More... | |
virtual Type | integrate (const scalar x1, const scalar x2) const |
Integrate between two (scalar) values. More... | |
virtual void | writeData (Ostream &os) const |
Write in dictionary format. More... | |
Protected Attributes | |
const Time & | time_ |
Reference to the time database. More... | |
const word | name_ |
Name of the data entry. More... | |
autoPtr< Function1< Type > > | entry_ |
The underlying Function1. More... | |
Friends | |
Ostream & | operator (Ostream &os, const TimeFunction1< Type > &de) |
Ostream Operator. More... | |
Light wrapper around Function1 to provide a mechanism to update time-based entries.
Definition at line 46 of file TimeFunction1.H.
TimeFunction1 | ( | const Time & | runTime, |
const word & | name, | ||
const dictionary & | dict | ||
) |
Construct from entry name and dictionary.
Definition at line 28 of file TimeFunction1.C.
TimeFunction1 | ( | const Time & | runTime, |
const word & | entryName | ||
) |
Construct from entry name.
Definition at line 45 of file TimeFunction1.C.
TimeFunction1 | ( | const TimeFunction1< Type > & | rhs | ) |
Copy construct.
Definition at line 58 of file TimeFunction1.C.
References TimeFunction1< Type >::entry_.
|
virtualdefault |
Destructor.
void reset | ( | const dictionary & | dict | ) |
Reset entry by re-reading from dictionary.
Definition at line 76 of file TimeFunction1.C.
References dict, and Foam::New().
const Foam::word & name | ( | ) | const |
Return the name of the entry.
Definition at line 84 of file TimeFunction1.C.
|
virtual |
Return value as a function of (scalar) independent variable.
Definition at line 91 of file TimeFunction1.C.
References x.
|
virtual |
Integrate between two (scalar) values.
Definition at line 99 of file TimeFunction1.C.
|
virtual |
Write in dictionary format.
Definition at line 126 of file TimeFunction1.C.
References os().
|
friend |
Ostream Operator.
|
protected |
Reference to the time database.
Definition at line 65 of file TimeFunction1.H.
|
protected |
Name of the data entry.
Definition at line 70 of file TimeFunction1.H.
The underlying Function1.
Definition at line 75 of file TimeFunction1.H.
Referenced by TimeFunction1< Type >::TimeFunction1().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.