Templated function that returns a constant value. More...
Public Member Functions | |
| TypeName ("constant") | |
| Constant (const word &entryName, const Type &val) | |
| Construct from entry name and value. More... | |
| Constant (const word &entryName, const dictionary &dict) | |
| Construct from entry name and dictionary. More... | |
| Constant (const word &entryName, Istream &is) | |
| Construct from entry 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 | integrate (const scalar x1, const scalar x2) const |
| Integrate between two values. 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... | |
| virtual void | writeData (Ostream &os) const |
| Write in dictionary format. More... | |
| template<> | |
| tmp< Field< label > > | integrate (const scalarField &x1, const scalarField &x2) const |
| Integrate between two (scalar) values. More... | |
| template<> | |
| Foam::tmp< Foam::Field< Foam::label > > | integrate (const scalarField &x1, const scalarField &x2) const |
| Integrate between two (scalar) values. More... | |
 Public Member Functions inherited from Function1< Type > | |
| TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
| Runtime type information. More... | |
| Function1 (const word &entryName) | |
| Construct from entry 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... | |
| virtual void | convertTimeBase (const Time &t) |
| Convert time. 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... | |
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) |
| Selector. More... | |
| Public Attributes inherited from Function1< Type > | |
| Function1 | |
| dictionary | |
| const word & | entryName |
| const word const dictionary & | dict |
| const word const dictionary | entryName |
| const word const dictionary | dict |
| Protected Member Functions inherited from refCount | |
| refCount () | |
| Construct null initializing count to 0. More... | |
| Protected Attributes inherited from Function1< Type > | |
| const word | name_ |
| Name of entry. More... | |
Templated function that returns a constant value.
Usage - for entry <entryName> returning the value
:
<entryName> constant <value>
Definition at line 56 of file Constant.H.
Construct from entry name and value.
Definition at line 32 of file Constant.C.
Referenced by Constant< Type >::Constant().
| Constant | ( | const word & | entryName, |
| const dictionary & | dict | ||
| ) |
Construct from entry name and dictionary.
Definition at line 44 of file Constant.C.
References Constant< Type >::Constant(), and dictionary::lookup().
Construct from entry name and Istream.
Reads the constant value without the Function1 type for backward compatibility
Definition at line 60 of file Constant.C.
Copy constructor.
Definition at line 71 of file Constant.C.
|
virtual |
Destructor.
Definition at line 81 of file Constant.C.
References Constant< Type >::value().
Referenced by Constant< Type >::clone().
| TypeName | ( | "constant" | ) |
Construct and return a clone.
Implements Function1< Type >.
Definition at line 95 of file Constant.H.
References Constant< Type >::integrate(), Constant< Type >::value(), Constant< Type >::writeData(), x, and Constant< Type >::~Constant().
|
inlinevirtual |
Return constant value.
Reimplemented from Function1< Type >.
Definition at line 31 of file ConstantI.H.
References Constant< Type >::integrate().
Referenced by Constant< Type >::clone(), and Constant< Type >::~Constant().
|
inlinevirtual |
Integrate between two values.
Reimplemented from Function1< Type >.
Definition at line 39 of file ConstantI.H.
Referenced by Constant< Type >::clone(), and Constant< Type >::value().
|
virtual |
Return value as a function of (scalar) independent variable.
Implements Function1< Type >.
Definition at line 89 of file Constant.C.
References Constant< Type >::integrate(), and List< T >::size().
|
virtual |
Integrate between two (scalar) values.
Implements Function1< Type >.
Definition at line 99 of file Constant.C.
|
virtual |
Write in dictionary format.
Reimplemented from Function1< Type >.
Definition at line 109 of file Constant.C.
References token::END_STATEMENT, Foam::nl, token::SPACE, and Function1< Type >::writeData().
Referenced by Constant< Type >::clone().
|
virtual |
Integrate between two (scalar) values.
Implements Function1< Type >.
|
virtual |
Integrate between two (scalar) values.
Implements Function1< Type >.
Definition at line 72 of file makeFunction1s.C.
References NotImplemented, and List< T >::size().
1.8.13
