Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or table, and provide functions to return the (interpolated) value, and integral between limits. More...
Public Member Functions | |
TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
Function1 (const word &entryName) | |
Construct from entry name. More... | |
Function1 (const Function1< Type > &de) | |
Copy constructor. More... | |
virtual tmp< Function1< Type > > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~Function1 () |
Destructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
virtual void | convertTimeBase (const Time &t) |
Convert time. More... | |
virtual Type | value (const scalar x) const |
Return value as a function of (scalar) independent variable. More... | |
virtual tmp< Field< Type > > | value (const scalarField &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 tmp< Field< Type > > | integrate (const scalarField &x1, const scalarField &x2) const |
Integrate between two (scalar) values. More... | |
virtual void | writeData (Ostream &os) const |
Write in dictionary format. More... | |
Public Member Functions inherited from refCount | |
int | count () const |
Return the current reference count. More... | |
bool | unique () const |
Return true if the reference count is zero. More... | |
void | operator++ () |
Increment the reference count. More... | |
void | operator++ (int) |
Increment the reference count. More... | |
void | operator-- () |
Decrement the reference count. More... | |
void | operator-- (int) |
Decrement the reference count. More... | |
Static Public Member Functions | |
static autoPtr< Function1< Type > > | New (const word &entryName, const dictionary &dict) |
Selector. More... | |
Public Attributes | |
Function1 | |
dictionary | |
const word & | entryName |
const word const dictionary & | dict |
const word const dictionary | entryName |
const word const dictionary | dict |
Protected Attributes | |
const word | name_ |
Name of entry. More... | |
Friends | |
Ostream & | operator (Ostream &os, const Function1< Type > &func) |
Ostream Operator. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from refCount | |
refCount () | |
Construct null initializing count to 0. More... | |
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or table, and provide functions to return the (interpolated) value, and integral between limits.
Definition at line 53 of file Function1.H.
|
virtual |
Destructor.
Definition at line 49 of file Function1.C.
TypeName | ( | "Function1< Type >" | ) |
Runtime type information.
Declare runtime constructor selection table
Construct and return a clone.
Implemented in Square< Type >, Sine< Type >, Scale< Type >, CSV< Type >, TableFile< Type >, Polynomial< Type >, Constant< Type >, Table< Type >, OneConstant< Type >, Uniform< Type >, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, quarterSineRamp, and ZeroConstant< Type >.
|
static |
Selector.
Definition at line 32 of file Function1New.C.
Referenced by CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), setTimeStepFunctionObject::read(), strainRateFunction::read(), temperatureDependent::readDict(), and rigidBodyMeshMotion::rigidBodyMeshMotion().
const Foam::word & name | ( | ) | const |
Return the name of the entry.
Definition at line 56 of file Function1.C.
Referenced by TableFile< Type >::writeData(), CSV< Type >::writeData(), Scale< Type >::writeData(), Sine< Type >::writeData(), and Square< Type >::writeData().
|
virtual |
Convert time.
Reimplemented in TableBase< Type >, and Polynomial< Type >.
Definition at line 63 of file Function1.C.
|
virtual |
Return value as a function of (scalar) independent variable.
Reimplemented in Square< Type >, Sine< Type >, Scale< Type >, TableBase< Type >, ramp, Polynomial< Type >, Constant< Type >, OneConstant< Type >, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, quarterSineRamp, and ZeroConstant< Type >.
Definition at line 68 of file Function1.C.
Referenced by Function1< Foam::Vector >::integrate().
|
virtual |
Return value as a function of (scalar) independent variable.
Definition at line 87 of file Function1.C.
|
virtual |
Integrate between two (scalar) values.
Reimplemented in TableBase< Type >, Polynomial< Type >, Constant< Type >, OneConstant< Type >, and ZeroConstant< Type >.
Definition at line 77 of file Function1.C.
Referenced by Function1< Foam::Vector >::value().
|
virtual |
Integrate between two (scalar) values.
Definition at line 104 of file Function1.C.
|
virtual |
Write in dictionary format.
Reimplemented in Square< Type >, Sine< Type >, TableBase< Type >, Scale< Type >, ramp, CSV< Type >, Polynomial< Type >, TableFile< Type >, Constant< Type >, OneConstant< Type >, and ZeroConstant< Type >.
Definition at line 121 of file Function1.C.
Referenced by OneConstant< Type >::writeData(), Constant< Type >::writeData(), TableFile< Type >::writeData(), Polynomial< Type >::writeData(), CSV< Type >::writeData(), ramp::writeData(), Scale< Type >::writeData(), TableBase< Type >::writeData(), Sine< Type >::writeData(), and Square< Type >::writeData().
|
protected |
Name of entry.
Definition at line 76 of file Function1.H.
Definition at line 88 of file Function1.H.
Definition at line 88 of file Function1.H.
const word& entryName |
Definition at line 88 of file Function1.H.
const word const dictionary& dict |
Definition at line 88 of file Function1.H.
const word const dictionary entryName |
Definition at line 88 of file Function1.H.
const word const dictionary dict |
Definition at line 88 of file Function1.H.