Returns a value retrieved from a function object result. More...
Public Member Functions | |
TypeName ("functionObjectValue") | |
Runtime type information. More... | |
void | operator= (const FunctionObjectValue< Type > &)=delete |
No copy assignment. More... | |
FunctionObjectValue (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name, dictionary and optional registry. More... | |
FunctionObjectValue (const FunctionObjectValue< Type > &rhs) | |
Copy construct. More... | |
virtual tmp< Function1< Type > > | clone () const |
Construct and return a clone. More... | |
virtual | ~FunctionObjectValue ()=default |
Destructor. More... | |
virtual Type | value (const scalar) const |
Return value at current time. More... | |
virtual Type | integrate (const scalar x1, const scalar x2) const |
Integrate between two (scalar) values. Not implemented! More... | |
virtual void | writeData (Ostream &os) const |
Write in dictionary format. More... | |
void | writeEntries (Ostream &os) const |
Write coefficient entries in dictionary format. More... | |
Public Member Functions inherited from Function1< Type > | |
TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name. More... | |
Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Function1 (const Function1< Type > &rhs) | |
Copy construct. More... | |
virtual | ~Function1 ()=default |
Destructor. More... | |
virtual bool | constant () const |
Is value constant (i.e. independent of x) 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... | |
void | writeEntries (Ostream &os) const |
Write coefficient entries in dictionary format. 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, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
Selector, with fallback redirection. More... | |
static autoPtr< Function1< Type > > | NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
Compatibility selector, with fallback redirection. More... | |
static autoPtr< Function1< Type > > | New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
Selector, without fallback redirection. More... | |
static autoPtr< Function1< Type > > | NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr) |
An optional selector. More... | |
static refPtr< Function1< Type > > | New (HashPtrTable< Function1< Type >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
Public Attributes inherited from Function1< Type > | |
Function1 | |
dictionary | |
const word & | entryName |
const word const dictionary & | dict |
const word const dictionary const objectRegistry * | obrPtr |
const word const dictionary const objectRegistry | entryName |
const word const dictionary const objectRegistry | dict |
const word const dictionary const objectRegistry | obrPtr |
Protected Member Functions inherited from Function1< Type > | |
void | operator= (const Function1< Type > &)=delete |
No copy assignment. More... | |
Returns a value retrieved from a function object result.
<entryName> functionObjectValue; <entryName>Coeffs { functionObject <name>; functionObjectResult <function object result field>; defaultValue <value>; // optional }
Definition at line 68 of file FunctionObjectValue.H.
FunctionObjectValue | ( | const word & | entryName, |
const dictionary & | dict, | ||
const objectRegistry * | obrPtr = nullptr |
||
) |
Construct from entry name, dictionary and optional registry.
Definition at line 46 of file FunctionObjectValue.C.
References dict, and Foam::blockMeshTools::read().
|
explicit |
Copy construct.
Definition at line 64 of file FunctionObjectValue.C.
|
virtualdefault |
Destructor.
TypeName | ( | "functionObjectValue" | ) |
Runtime type information.
|
delete |
No copy assignment.
Construct and return a clone.
Implements Function1< Type >.
Definition at line 119 of file FunctionObjectValue.H.
|
inlinevirtual |
Return value at current time.
Reimplemented from Function1< Type >.
Definition at line 34 of file FunctionObjectValueI.H.
References DebugInfo, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
|
inlinevirtual |
Integrate between two (scalar) values. Not implemented!
Reimplemented from Function1< Type >.
Definition at line 92 of file FunctionObjectValueI.H.
References NotImplemented.
|
virtual |
Write in dictionary format.
Reimplemented from Function1< Type >.
Definition at line 96 of file FunctionObjectValue.C.
References Foam::name(), os(), and writeData().
void writeEntries | ( | Ostream & | os | ) | const |
Write coefficient entries in dictionary format.
Definition at line 80 of file FunctionObjectValue.C.
References os().