Ramp< Function1Type > Class Template 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< Function1Type >:
Collaboration diagram for Ramp< Function1Type >:

Public Member Functions

 Ramp (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual ~Ramp ()
 Destructor. More...
 
virtual scalar value (const scalar t) const =0
 Return value for time t. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write data to dictionary stream. More...
 
void operator= (const Ramp< Function1Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction1< scalar, Function1Type >
 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 scalar integral (const scalar x1, const scalar x2) const=0
 Integrate between two scalar values. 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 >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< scalar > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual bool constant () const
 Is this function guaranteed to be constant? 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 

Protected Attributes

const scalar start_
 Start-time of the ramp function. More...
 
const 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 &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< scalar > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< scalar > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< scalar > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
 Select from Istream. More...
 

Detailed Description

template<class Function1Type>
class Foam::Function1s::Ramp< Function1Type >

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
    <name> <rampFunction>;
    <name>Coeffs
    {
        start     10;
        duration  20;
    }
or
    <name>
    {
        type      <rampFunction>;
        start     10;
        duration  20;
    }
or including a constant scaling factor:
    <name>
    {
        type      scale;

        scale
        {
            type        <rampFunction>;

            start       0;
            duration    10;
        }

        value       100;
    }
for more details of scaling the ramp see Foam::Function1s::Scale.

Where:

Property Description Required Default value
start Start time no 0
duration Duration yes
See also
Foam::Function1 Foam::Function1s::Scale
Source files

Definition at line 116 of file Ramp.H.

Constructor & Destructor Documentation

◆ Ramp()

Ramp ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 31 of file Ramp.C.

◆ ~Ramp()

~Ramp
virtual

Destructor.

Definition at line 47 of file Ramp.C.

Member Function Documentation

◆ end()

scalar end ( ) const
inlineprotected

Return the end-time of the ramp function.

Definition at line 131 of file Ramp.H.

References Ramp< Function1Type >::duration_, and Ramp< Function1Type >::start_.

◆ linearRamp()

scalar linearRamp ( const scalar  t) const
inlineprotected

Simple linear ramp function which form the basis of many more.

complex ramp functions

Definition at line 138 of file Ramp.H.

Referenced by linearRamp::integral(), and linearRamp::value().

Here is the caller graph for this function:

◆ dLinearRampDt()

scalar dLinearRampDt ( ) const
inlineprotected

The gradient of the linear ramp within the bounds of the ramp.

duration

Definition at line 145 of file Ramp.H.

◆ value()

virtual scalar value ( const scalar  t) const
pure virtual

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write data to dictionary stream.

Implements Function1< scalar >.

Reimplemented in reverseRamp.

Definition at line 54 of file Ramp.C.

References Foam::units(), and Foam::Function1s::writeEntry().

Referenced by reverseRamp::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const Ramp< Function1Type > &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ start_

const scalar start_
protected

Start-time of the ramp function.

Definition at line 125 of file Ramp.H.

Referenced by Ramp< Function1Type >::end().

◆ duration_

const scalar duration_
protected

Duration of the ramp function.

Definition at line 128 of file Ramp.H.

Referenced by Ramp< Function1Type >::end().


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