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...
|
| virtual const word & | type () const |
| | Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr) |
| | Construct from entry name.
|
| | Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| | Construct from entry name, (unused) dictionary and optional registry.
|
| | Function1 (const Function1< Type > &rhs) |
| | Copy construct.
|
| virtual tmp< Function1< Type > > | clone () const =0 |
| | Return a clone.
|
| virtual | ~Function1 ()=default |
| | Destructor.
|
| virtual bool | constant () const |
| | Is value constant (i.e. independent of x).
|
| virtual bool | good () const |
| | Can function be evaluated?
|
| virtual Type | value (const scalar x) const |
| | Return value as a function of (scalar) independent variable.
|
| virtual tmp< Field< Type > > | value (const scalarField &x) const |
| | Return value as a function of (scalar) independent variable.
|
| virtual Type | integrate (const scalar x1, const scalar x2) const |
| | Integrate between two (scalar) values.
|
| virtual tmp< Field< Type > > | integrate (const scalarField &x1, const scalarField &x2) const |
| | Integrate between two (scalar) values.
|
| virtual void | writeData (Ostream &os) const |
| | Write in dictionary format.
|
| virtual void | writeEntries (Ostream &os) const |
| | Write coefficient entries in dictionary format.
|
| const::Foam::word | typeName (Function1< label >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< label >::typeName_(), 0)) |
| Function1< label >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< label >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< label >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< label >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| const::Foam::word | typeName (Function1< scalar >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< scalar >::typeName_(), 0)) |
| Function1< scalar >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< scalar >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< scalar >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< scalar >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| const::Foam::word | typeName (Function1< vector >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< vector >::typeName_(), 0)) |
| Function1< vector >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< vector >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< vector >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< vector >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| const::Foam::word | typeName (Function1< sphericalTensor >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< sphericalTensor >::typeName_(), 0)) |
| Function1< sphericalTensor >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< sphericalTensor >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< sphericalTensor >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< sphericalTensor >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| const::Foam::word | typeName (Function1< symmTensor >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< symmTensor >::typeName_(), 0)) |
| Function1< symmTensor >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< symmTensor >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< symmTensor >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< symmTensor >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| const::Foam::word | typeName (Function1< tensor >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< tensor >::typeName_(), 0)) |
| Function1< tensor >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< tensor >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< tensor >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< tensor >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| const::Foam::word | typeName (Function1< scalarField >::typeName_()) |
| int | debug (::Foam::debug::debugSwitch(Function1< scalarField >::typeName_(), 0)) |
| Function1< scalarField >::dictionaryConstructorTableType * | dictionaryConstructorTablePtr_ (nullptr) |
| std::unique_ptr< Function1< scalarField >::dictionaryConstructorCompatTableType > | dictionaryConstructorCompatTablePtr_ (nullptr) |
| Function1< scalarField >::dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| void | dictionaryConstructorTablePtr_construct (bool load) |
| Function1< scalarField >::dictionaryConstructorPtr | dictionaryConstructorTable (const::Foam::word &k) |
| | function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr) |
| | Construct from entry name and optional registry.
|
| | function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| | Construct from entry name, dictionary (unused) and optional registry.
|
| | function1Base (const function1Base &rhs) |
| | Copy construct.
|
| virtual | ~function1Base () |
| | Destructor.
|
| const word & | name () const noexcept |
| | The name of the entry.
|
| const objectRegistry * | whichDb () const noexcept |
| | Return the associated registry or nullptr.
|
| void | resetDb (const objectRegistry *obrPtr=nullptr) noexcept |
| | Reset the associated objectRegistry.
|
| void | resetDb (const objectRegistry &db) noexcept |
| | Reset the associated objectRegistry.
|
| const objectRegistry & | obr () const |
| | Return the object registry.
|
| bool | isTime () const noexcept |
| | Return true if this function was created with the time database.
|
| const Time & | time () const |
| | Return the time database.
|
| template<class MeshType> |
| const MeshType & | mesh (const word ®ionName=word::null) const |
| | Return the mesh database if this Function1 was created using a mesh.
|
| virtual void | userTimeToTime (const Time &t) |
| | Convert time.
|
| constexpr | refCount () noexcept |
| | Default construct, initializing count to 0.
|
| int | use_count () const noexcept |
| | Return the current reference count.
|
| bool | unique () const noexcept |
| | Return true if the reference count is zero.
|
| void | operator++ () noexcept |
| | Increment the reference count.
|
| void | operator++ (int) noexcept |
| | Increment the reference count.
|
| void | operator-- () noexcept |
| | Decrement the reference count.
|
| void | operator-- (int) noexcept |
| | Decrement the reference count.
|
|
| static const char * | typeName_ () |
| | Runtime type information.
|
| static dictionaryConstructorCompatTableType & | dictionaryConstructorCompatTable () |
| static void | dictionaryConstructorTablePtr_construct (bool load) |
| static dictionaryConstructorPtr | dictionaryConstructorTable (const ::Foam::word &k) |
| template<class Derived> |
| static tmp< Function1< Type > > | Clone (const Derived &fun) |
| | Clone a Function1.
|
| 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.
|
| 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.
|
| static autoPtr< Function1< Type > > | New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
| | Selector, without fallback redirection.
|
| static autoPtr< Function1< Type > > | NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr) |
| | An optional selector, with fallback redirection.
|
| static autoPtr< Function1< Type > > | NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| | An optional selector, without fallback redirection.
|
| 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) |
| | Selector with external storage of Function1. This also allows wildcard matches in a dictionary.
|
template<class Type>
class Foam::Function1< Type >
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.
The New factory method attempts to deal with varying types of input. It accepts primitive or dictionary entries for dispatching to different function types, but wraps unspecified types as "constant".
In the dictionary form, the coefficients are the dictionary itself. This is arguably the more readable form. For example,
<entryName>
{
type linearRamp;
start 10;
duration 20;
}
In the primitive form, the coefficients are provided separately. For example,
<entryName> linearRamp;
<entryName>Coeffs
{
start 10;
duration 20;
}
The coeffs dictionary is optional, since it is not required by all types. For example,
<entryName> zero;
- Source files
-
Definition at line 89 of file Function1.H.
1.16.1