Templated function that returns a constant value. More...
Public Member Functions | |
TypeName ("constant") | |
Constant (const word &name, const Type &val) | |
Construct from name and value. More... | |
Constant (const word &name, const dictionary &dict) | |
Construct from name and dictionary. More... | |
Constant (const word &name, Istream &is) | |
Construct from name and Istream. More... | |
Constant (const Constant< Type > &cnst) | |
Copy constructor. More... | |
virtual tmp< Function1< Type > > | clone () const |
Construct and return a clone. More... | |
virtual | ~Constant () |
Destructor. More... | |
virtual Type | value (const scalar) const |
Return constant value. More... | |
virtual Type | integral (const scalar x1, const scalar x2) const |
Integrate between two values. More... | |
virtual void | write (Ostream &os) const |
Write in dictionary format. More... | |
void | operator= (const Constant< Type > &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from FieldFunction1< Type, Constant< Type > > | |
FieldFunction1 (const word &name) | |
Construct from name. More... | |
virtual | ~FieldFunction1 () |
Destructor. More... | |
virtual tmp< Field< Type > > | value (const scalarField &x) const |
Return value as a function of one scalar field. More... | |
virtual tmp< Field< Type > > | integral (const scalarField &x1, const scalarField &x2) const |
Integrate between two scalar fields. More... | |
Public Member Functions inherited from Function1< Type > | |
TypeName ("Function1") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const dictionary &dict),(name, dict)) | |
Declare runtime constructor selection table. More... | |
Function1 (const word &name) | |
Construct from name. More... | |
Function1 (const Function1< Type > &f1) | |
Copy constructor. More... | |
virtual | ~Function1 () |
Destructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
void | operator= (const Function1< Type > &) |
Assignment. 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... | |
void | operator= (const refCount &)=delete |
Disallow bitwise assignment. 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 &name, const dictionary &dict) |
Selector. More... | |
Protected Member Functions inherited from refCount | |
refCount () | |
Construct null initialising count to 0. More... | |
refCount (const refCount &)=delete | |
Disallow copy. More... | |
Protected Attributes inherited from Function1< Type > | |
const word | name_ |
Name of entry. More... | |
Templated function that returns a constant value.
:
<name> constant <value>
Definition at line 57 of file Constant.H.
Construct from name and value.
Definition at line 31 of file Constant.C.
Constant | ( | const word & | name, |
const dictionary & | dict | ||
) |
Construct from name and dictionary.
Definition at line 43 of file Constant.C.
References dict, IOstream::eof(), and Function1< Type >::name().
Construct from name and Istream.
Reads the constant value without the Function1 type for backward compatibility
Definition at line 74 of file Constant.C.
Copy constructor.
Definition at line 86 of file Constant.C.
|
virtual |
Destructor.
Definition at line 96 of file Constant.C.
TypeName | ( | "constant" | ) |
Construct and return a clone.
Reimplemented from FieldFunction1< Type, Constant< Type > >.
Definition at line 90 of file Constant.H.
|
inlinevirtual |
Return constant value.
Implements FieldFunction1< Type, Constant< Type > >.
Definition at line 31 of file ConstantI.H.
|
inlinevirtual |
Integrate between two values.
Implements FieldFunction1< Type, Constant< Type > >.
Definition at line 38 of file ConstantI.H.
|
virtual |
Write in dictionary format.
Implements Function1< Type >.
Definition at line 103 of file Constant.C.
References Foam::Function1s::writeEntry().