ramp Class Referenceabstract

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...

Inheritance diagram for ramp:
[legend]
Collaboration diagram for ramp:
[legend]

Public Member Functions

 ramp (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual ~ramp ()=default
 Destructor. More...
 
virtual void convertTimeBase (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)
 Construct from entry name. More...
 
 Function1 (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 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 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 bool mandatory=true)
 Selector, with fallback redirection. More...
 
static autoPtr< Function1< scalar > > New (const word &entryName, const dictionary &dict, const bool mandatory=true)
 Selector, without fallback redirection. More...
 
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 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)
 An optional selector. More...
 
- Public Attributes inherited from Function1< scalar >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionary entryName
 
const word const dictionarydict
 
const word const dictionary dict
 

Detailed Description

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.

Usage:

    <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
See also
Foam::Function1
Source files

Definition at line 99 of file ramp.H.

Constructor & Destructor Documentation

◆ ramp()

ramp ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 41 of file ramp.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~ramp()

virtual ~ramp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ linearRamp()

scalar linearRamp ( const scalar  t) const
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_.

Here is the call graph for this function:

◆ convertTimeBase()

void convertTimeBase ( const Time t)
virtual

Convert time.

Definition at line 61 of file ramp.C.

References TimeState::timeToUserTime().

Here is the call graph for this function:

◆ value()

virtual scalar value ( const scalar  t) const
pure virtual

Return value for time t.

Reimplemented from Function1< scalar >.

Implemented in stepFunction, halfCosineRamp, linearRamp, quadraticRamp, quarterCosineRamp, and quarterSineRamp.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< scalar >.

Definition at line 68 of file ramp.C.

References Ostream::beginBlock(), token::END_STATEMENT, Ostream::endBlock(), Foam::name(), Foam::nl, and Function1< Type >::writeData().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream os) const

Write coefficient entries in dictionary format.

Definition at line 54 of file ramp.C.

References Ostream::writeEntry().

Here is the call graph for this function:

Member Data Documentation

◆ start_

scalar start_
protected

Start-time of the ramp function.

Definition at line 108 of file ramp.H.

Referenced by ramp::linearRamp().

◆ duration_

scalar duration_
protected

Duration of the ramp function.

Definition at line 111 of file ramp.H.

Referenced by ramp::linearRamp().


The documentation for this class was generated from the following files: