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) | |
Construct from entry name and dictionary. More... | |
virtual | ~Ramp () |
Destructor. 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 | operator= (const Ramp< Function1Type > &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from FieldFunction1< scalar, Function1Type > | |
FieldFunction1 (const word &entryName) | |
Construct from entry name. More... | |
FieldFunction1 (const FieldFunction1< scalar, Function1Type > &ff1) | |
Copy constructor. More... | |
virtual tmp< Function1< scalar > > | clone () const |
Construct and return a clone. More... | |
virtual | ~FieldFunction1 () |
Destructor. 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=0 |
Integrate between two (scalar) values. More... | |
virtual tmp< Field< scalar > > | integrate (const scalarField &x1, const scalarField &x2) const |
Integrate between two (scalar) values. More... | |
Public Member Functions inherited from Function1< scalar > | |
Function1 (const word &entryName) | |
Construct from entry name. More... | |
Function1 (const Function1< scalar > &f1) | |
Copy constructor. More... | |
TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
virtual | ~Function1 () |
Destructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
void | operator= (const Function1< scalar > &)=delete |
Disallow default bitwise 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... | |
Protected Member Functions | |
scalar | end () const |
Return the end-time of the ramp function. More... | |
scalar | linearRamp (const scalar t) const |
Simple linear ramp function which form the basis of many more. More... | |
scalar | dLinearRampDt () const |
The gradient of the linear ramp within the bounds of the ramp. More... | |
Protected Member Functions inherited from refCount | |
refCount () | |
Construct null initializing count to 0. More... | |
Protected Attributes | |
scalar | start_ |
Start-time of the ramp function. More... | |
scalar | duration_ |
Duration of the ramp function. More... | |
Protected Attributes inherited from Function1< scalar > | |
const word | name_ |
Name of entry. 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) |
Selector. More... | |
Public Attributes inherited from Function1< scalar > | |
Function1 | |
dictionary | |
const word & | entryName |
const word const dictionary | entryName |
const word const dictionary & | dict |
const word const dictionary | dict |
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 | ||
) |
Construct from entry name and dictionary.
Definition at line 40 of file Ramp.C.
Referenced by Ramp< linearRamp >::end().
|
virtual |
Destructor.
Definition at line 54 of file Ramp.C.
Referenced by Ramp< linearRamp >::end().
|
inlineprotected |
|
inlineprotected |
Simple linear ramp function which form the basis of many more.
complex ramp functions
Definition at line 119 of file Ramp.H.
Referenced by Ramp< linearRamp >::end().
|
inlineprotected |
The gradient of the linear ramp within the bounds of the ramp.
duration
Definition at line 126 of file Ramp.H.
Referenced by Ramp< linearRamp >::end().
|
pure virtual |
Return value for time t.
Implements FieldFunction1< scalar, Function1Type >.
Implemented in reverseRamp, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, and quarterSineRamp.
Referenced by Ramp< linearRamp >::end().
|
virtual |
Write in dictionary format.
Reimplemented from Function1< scalar >.
Reimplemented in reverseRamp.
Definition at line 61 of file Ramp.C.
Referenced by Ramp< linearRamp >::end(), and reverseRamp::writeData().
Disallow default bitwise assignment.
Referenced by Ramp< linearRamp >::end().
|
protected |
Duration of the ramp function.
Definition at line 109 of file Ramp.H.
Referenced by Ramp< linearRamp >::end().