Half-cosine ramp function starting from 0 and increasing to 1 from start
over the duration
and remaining at 1 thereafter.
More...
Public Member Functions | |
TypeName ("halfCosineRamp") | |
halfCosineRamp (const word &name, const dictionary &dict) | |
Construct from name and dictionary. More... | |
virtual | ~halfCosineRamp () |
Destructor. More... | |
virtual scalar | value (const scalar t) const |
Return value for time t. More... | |
virtual scalar | integral (const scalar t1, const scalar t2) const |
Return the integral between times t1 and t2. More... | |
void | operator= (const halfCosineRamp &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from Ramp< halfCosineRamp > | |
Ramp (const word &name, const dictionary &dict) | |
Construct from name and dictionary. More... | |
virtual | ~Ramp () |
Destructor. More... | |
virtual void | write (Ostream &os) const |
Write data to dictionary stream. More... | |
void | operator= (const Ramp< halfCosineRamp > &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from FieldFunction1< scalar, halfCosineRamp > | |
FieldFunction1 (const word &name) | |
Construct from name. 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 one scalar field. More... | |
virtual tmp< Field< scalar > > | integral (const scalarField &x1, const scalarField &x2) const |
Integrate between two scalar fields. More... | |
Public Member Functions inherited from Function1< scalar > | |
Function1 (const word &name) | |
Construct from name. More... | |
Function1 (const Function1< scalar > &f1) | |
Copy constructor. More... | |
const word & | name () const |
Return the name of the entry. More... | |
TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
virtual | ~Function1 () |
Destructor. More... | |
void | operator= (const Function1< scalar > &) |
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 &name, const dictionary &dict) |
Selector. More... | |
Public Attributes inherited from Function1< scalar > | |
Function1 | |
dictionary | |
const word & | name |
const word const dictionary | name |
const word const dictionary & | dict |
const word const dictionary | dict |
Protected Member Functions inherited from Ramp< halfCosineRamp > | |
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 initialising count to 0. More... | |
Protected Attributes inherited from Ramp< halfCosineRamp > | |
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... | |
Half-cosine ramp function starting from 0 and increasing to 1 from start
over the duration
and remaining at 1 thereafter.
Definition at line 54 of file halfCosineRamp.H.
halfCosineRamp | ( | const word & | name, |
const dictionary & | dict | ||
) |
Construct from name and dictionary.
Definition at line 42 of file halfCosineRamp.C.
|
virtual |
Destructor.
Definition at line 53 of file halfCosineRamp.C.
TypeName | ( | "halfCosineRamp" | ) |
|
inlinevirtual |
Return value for time t.
Implements Ramp< halfCosineRamp >.
Definition at line 32 of file halfCosineRampI.H.
References Foam::cos(), halfCosineRamp::integral(), and Foam::constant::mathematical::pi().
|
inlinevirtual |
Return the integral between times t1 and t2.
Implements FieldFunction1< scalar, halfCosineRamp >.
Definition at line 41 of file halfCosineRampI.H.
References Foam::min(), Foam::constant::mathematical::pi(), and Foam::sin().
Referenced by halfCosineRamp::value().
|
delete |
Disallow default bitwise assignment.