Templated function that returns a constant value. More...
Public Member Functions | |
TypeName ("uniform") | |
virtual tmp< Function1< Type > > | clone () const |
Construct and return a clone. More... | |
Public Member Functions inherited from Constant< Type > | |
TypeName ("constant") | |
Constant (const word &name, const Type &val) | |
Construct from name and value. More... | |
Constant (const word &name, const unitConversions &units, const dictionary &dict) | |
Construct from name and dictionary. More... | |
Constant (const word &name, const unitConversions &units, Istream &is) | |
Construct from name and Istream. More... | |
Constant (const Constant< Type > &cnst) | |
Copy constructor. 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 bool | constant () const |
Is this function guaranteed to be constant? More... | |
virtual void | write (Ostream &os, const unitConversions &units) 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 Function1s::unitConversions &units, const dictionary &dict),(name, units, dict)) | |
declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is)) | |
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 Function1s::unitConversions &units, const dictionary &dict) |
Select from dictionary. More... | |
static autoPtr< Function1< Type > > | New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict) |
Select from dictionary. More... | |
static autoPtr< Function1< Type > > | New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is) |
Select from Istream. More... | |
static autoPtr< Function1< Type > > | New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is) |
Select from Istream. 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.
Provides backward-compatibility for cases where a field is spatially "uniform" and may be treated as a constant value.
:
<name> uniform <value>
TypeName | ( | "uniform" | ) |
Construct and return a clone.
Reimplemented from Constant< Type >.