Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically to 1 from start
over the duration
and remaining at 1 thereafter.
More...
Public Member Functions | |
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 scalar | value (const scalar t) const =0 |
Return value for time t. More... | |
virtual void | writeData (Ostream &os) const |
Write in dictionary format. More... | |
void | writeEntries (Ostream &os) const |
Write coefficient entries in dictionary format. More... | |
Public Member Functions inherited from Function1< scalar > | |
Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name. More... | |
Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
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 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... | |
void | writeEntries (Ostream &os) const |
Write coefficient entries in dictionary format. More... | |
Protected Member Functions | |
scalar | linearRamp (const scalar t) const |
Protected Member Functions inherited from Function1< scalar > | |
void | operator= (const Function1< scalar > &)=delete |
No copy assignment. More... | |
Protected Attributes | |
scalar | start_ |
Start-time of the ramp function. More... | |
scalar | duration_ |
Duration of the ramp function. More... | |
Additional Inherited Members | |
Public Types inherited from Function1< scalar > | |
typedef scalar | returnType |
Static Public Member Functions inherited from Function1< scalar > | |
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) |
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=word::null, const objectRegistry *obrPtr=nullptr) |
An optional selector. More... | |
Public Attributes inherited from Function1< scalar > | |
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 |
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically to 1 from start
over the duration
and remaining at 1 thereafter.
<entryName> <rampFunction>; <entryName>Coeffs { start 10; duration 20; }
or
<entryName> { type <rampFunction>; start 10; duration 20; }
Where:
Property | Description | Required | Default value |
---|---|---|---|
start | Start time | no | 0 |
duration | Duration | yes |
ramp | ( | const word & | entryName, |
const dictionary & | dict, | ||
const objectRegistry * | obrPtr = nullptr |
||
) |
Construct from entry name, dictionary and optional registry.
Definition at line 41 of file ramp.C.
References dict, and Foam::read().
|
virtualdefault |
Destructor.
|
inlineprotected |
Simple linear ramp function that forms the basis of many more complex ramp functions
Definition at line 115 of file ramp.H.
References ramp::duration_, Foam::max(), Foam::min(), and ramp::start_.
|
virtual |
Convert time.
Definition at line 62 of file ramp.C.
References TimeState::userTimeToTime().
|
pure virtual |
Return value for time t.
Reimplemented from Function1< scalar >.
Implemented in stepFunction, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, and quarterSineRamp.
|
virtual |
Write in dictionary format.
Reimplemented from Function1< scalar >.
Definition at line 69 of file ramp.C.
References Foam::name(), os(), and Function1< Type >::writeData().
void writeEntries | ( | Ostream & | os | ) | const |
|
protected |
Start-time of the ramp function.
Definition at line 108 of file ramp.H.
Referenced by ramp::linearRamp().
|
protected |
Duration of the ramp function.
Definition at line 111 of file ramp.H.
Referenced by ramp::linearRamp().