Quarter-sine ramp function starting from 0 and increasing to 1 from start over the duration and remaining at 1 thereafter.
More...


Public Member Functions | |
| TypeName ("quarterSineRamp") | |
| quarterSineRamp (const word &entryName, const dictionary &dict) | |
| Construct from entry name and dictionary. More... | |
| virtual tmp< Function1< scalar > > | clone () const |
| Construct and return a clone. More... | |
| virtual | ~quarterSineRamp () |
| Destructor. More... | |
| scalar | value (const scalar t) const |
| Return value for time t. More... | |
Public Member Functions inherited from ramp | |
| 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... | |
Public Member Functions inherited from Function1< scalar > | |
| Function1 (const word &entryName) | |
| Construct from entry name. More... | |
| Function1 (const Function1< scalar > &de) | |
| 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... | |
| virtual void | convertTimeBase (const Time &t) |
| Convert time. 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... | |
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 | |
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 | |
| scalar | linearRamp (const scalar t) const |
| Simple linear ramp function. More... | |
Protected Member Functions inherited from refCount | |
| refCount () | |
| Construct null initializing count to 0. More... | |
Protected Attributes inherited from ramp | |
| 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... | |
Quarter-sine 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 quarterSineRamp.H.
| quarterSineRamp | ( | const word & | entryName, |
| const dictionary & | dict | ||
| ) |
Construct from entry name and dictionary.
Definition at line 43 of file quarterSineRamp.C.
Referenced by quarterSineRamp::clone().

|
virtual |
Destructor.
Definition at line 54 of file quarterSineRamp.C.
Referenced by quarterSineRamp::clone().

| TypeName | ( | "quarterSineRamp" | ) |
Construct and return a clone.
Implements Function1< scalar >.
Definition at line 80 of file quarterSineRamp.H.
References quarterSineRamp::quarterSineRamp(), quarterSineRamp::value(), and quarterSineRamp::~quarterSineRamp().

|
virtual |
Return value for time t.
Implements ramp.
Definition at line 60 of file quarterSineRamp.C.
References Foam::constant::mathematical::pi(), and Foam::sin().
Referenced by quarterSineRamp::clone().


1.8.13