Linear ramp function starting from 0 and increasing linearRamply to 1 from start over the duration and remaining at 1 thereafter.
More...


Public Member Functions | |
| TypeName ("linearRamp") | |
| linearRamp (const word &entryName, const dictionary &dict) | |
| Construct from entry name and dictionary. More... | |
| virtual | ~linearRamp () |
| Destructor. More... | |
| virtual scalar | value (const scalar t) const |
| Return value for time t. More... | |
| virtual scalar | integrate (const scalar t1, const scalar t2) const |
| Return the integral between times t1 and t2. More... | |
| void | operator= (const linearRamp &)=delete |
| Disallow default bitwise assignment. More... | |
Public Member Functions inherited from Ramp< linearRamp > | |
| Ramp (const word &entryName, const dictionary &dict) | |
| Construct from entry name and dictionary. More... | |
| virtual | ~Ramp () |
| Destructor. More... | |
| virtual void | writeData (Ostream &os) const |
| Write in dictionary format. More... | |
| void | operator= (const Ramp< linearRamp > &)=delete |
| Disallow default bitwise assignment. More... | |
Public Member Functions inherited from FieldFunction1< scalar, linearRamp > | |
| FieldFunction1 (const word &entryName) | |
| Construct from entry name. More... | |
| FieldFunction1 (const FieldFunction1< scalar, linearRamp > &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 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... | |
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 |
Protected Member Functions inherited from Ramp< linearRamp > | |
| 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 inherited from Ramp< linearRamp > | |
| 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... | |
Linear ramp function starting from 0 and increasing linearRamply to 1 from start over the duration and remaining at 1 thereafter.
Definition at line 54 of file linearRamp.H.
| linearRamp | ( | const word & | entryName, |
| const dictionary & | dict | ||
| ) |
Construct from entry name and dictionary.
Definition at line 42 of file linearRamp.C.
|
virtual |
Destructor.
Definition at line 53 of file linearRamp.C.
| TypeName | ( | "linearRamp" | ) |
|
inlinevirtual |
Return value for time t.
Implements Ramp< linearRamp >.
Definition at line 31 of file linearRampI.H.
References linearRamp::integrate().

|
inlinevirtual |
Return the integral between times t1 and t2.
Implements FieldFunction1< scalar, linearRamp >.
Definition at line 40 of file linearRampI.H.
References Foam::min(), and Foam::sqr().
Referenced by linearRamp::value().


|
delete |
Disallow default bitwise assignment.