|
| TypeName ("linearRamp") |
|
| linearRamp (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| Construct from entry name, dictionary and optional registry. More...
|
|
virtual | ~linearRamp ()=default |
| Destructor. More...
|
|
virtual scalar | value (const scalar t) const |
| Return value for time t. More...
|
|
| ramp (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| Construct from entry name, dictionary and optional registry. More...
|
|
virtual | ~ramp ()=default |
| Destructor. More...
|
|
virtual void | userTimeToTime (const Time &t) |
| Convert time. More...
|
|
virtual void | writeData (Ostream &os) const |
| Write in dictionary format. More...
|
|
virtual void | writeEntries (Ostream &os) const |
| Write coefficient entries in dictionary format. 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) |
| Construct from entry name, (unused) dictionary and optional registry. More...
|
|
| Function1 (const Function1< scalar > &rhs) |
| Copy construct. More...
|
|
| TypeName ("Function1") declareRunTimeSelectionTable(autoPtr |
| Runtime type information. More...
|
|
virtual tmp< Function1< scalar > > | clone () const=0 |
| Construct and return a clone. More...
|
|
virtual | ~Function1 ()=default |
| Destructor. More...
|
|
virtual bool | constant () const |
| Is value constant (i.e. independent of x) More...
|
|
virtual bool | good () const |
| Can function be evaluated? More...
|
|
virtual tmp< Field< scalar > > | value (const scalarField &x) const |
| Return value as a function of (scalar) independent variable. More...
|
|
virtual scalar | integrate (const scalar x1, const scalar x2) const |
| Integrate between two (scalar) values. More...
|
|
virtual tmp< Field< scalar > > | integrate (const scalarField &x1, const scalarField &x2) const |
| Integrate between two (scalar) values. More...
|
|
| function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr) |
| Construct from entry name and optional registry. More...
|
|
| function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| Construct from entry name, dictionary (unused) and optional registry. More...
|
|
| function1Base (const function1Base &rhs) |
| Copy construct. More...
|
|
virtual | ~function1Base () |
| Destructor. More...
|
|
const word & | name () const noexcept |
| The name of the entry. More...
|
|
const objectRegistry * | whichDb () const noexcept |
| Return the associated registry or nullptr. More...
|
|
void | resetDb (const objectRegistry *obrPtr=nullptr) noexcept |
| Reset the associated objectRegistry. More...
|
|
void | resetDb (const objectRegistry &db) noexcept |
| Reset the associated objectRegistry. More...
|
|
const objectRegistry & | obr () const |
| Return the object registry. More...
|
|
bool | isTime () const noexcept |
| Return true if this function was created with the time database. More...
|
|
const Time & | time () const |
| Return the time database. More...
|
|
template<class MeshType > |
const MeshType & | mesh (const word ®ionName=word::null) const |
| Return the mesh database if this Function1 was created using a mesh. More...
|
|
constexpr | refCount () noexcept |
| Default construct, initializing count to 0. More...
|
|
int | use_count () const noexcept |
| Return the current reference count. More...
|
|
bool | unique () const noexcept |
| Return true if the reference count is zero. More...
|
|
void | operator++ () noexcept |
| Increment the reference count. More...
|
|
void | operator++ (int) noexcept |
| Increment the reference count. More...
|
|
void | operator-- () noexcept |
| Decrement the reference count. More...
|
|
void | operator-- (int) noexcept |
| Decrement the reference count. More...
|
|
|
typedef scalar | returnType |
| The return type. More...
|
|
static autoPtr< Function1< scalar > > | 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< scalar > > | New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
| Selector, without fallback redirection. More...
|
|
static refPtr< Function1< scalar > > | New (HashPtrTable< Function1< scalar >> &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. More...
|
|
static autoPtr< Function1< scalar > > | 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< scalar > > | NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr) |
| An optional selector, with fallback redirection. More...
|
|
static autoPtr< Function1< scalar > > | NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
| An optional selector, without fallback redirection. More...
|
|
| Function1 |
|
| dictionary |
|
const word & | entryName |
|
const word const dictionary const objectRegistry | entryName |
|
const word const dictionary & | dict |
|
const word const dictionary const objectRegistry | dict |
|
const word const dictionary const objectRegistry * | obrPtr |
|
const word const dictionary const objectRegistry | obrPtr |
|
scalar | linearRamp (const scalar t) const |
| Simple linear ramp function that forms the basis of many more complex ramp functions. More...
|
|
void | operator= (const Function1< scalar > &)=delete |
| No copy assignment. More...
|
|
void | operator= (const function1Base &)=delete |
| No copy assignment. More...
|
|
scalar | start_ |
| Start-time of the ramp function. More...
|
|
scalar | duration_ |
| Duration of the ramp function. More...
|
|
const word | name_ |
| Name of entry. More...
|
|
const objectRegistry * | obrPtr_ |
| Pointer to an object registry. More...
|
|
Linear ramp function starting from 0 and increasing linearly to 1 from start
over the duration
and remaining at 1 thereafter.
- See also
- Foam::Function1Types::ramp
- Source files
-
Definition at line 53 of file linearRamp.H.