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 ()
	Destructor. More...

scalar	value (const scalar t) const =0
	Return value for time t. 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 tmp< Function1< scalar > >	clone () const=0
	Construct and return a clone. 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...

Protected Member Functions
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
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...

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

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 96 of file ramp.H.

Constructor & Destructor Documentation

◆ ramp()

ramp	(	const word &	entryName,
		const dictionary &	dict
	)

Construct from entry name and dictionary.

Definition at line 38 of file ramp.C.

◆ ~ramp()

~ramp ( )

virtual

Destructor.

Definition at line 51 of file ramp.C.

Member Function Documentation

◆ 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 112 of file ramp.H.

Referenced by linearRamp::value().

Here is the caller graph for this function:

◆ value()

scalar value ( const scalar t ) const

pure virtual

Return value for time t.

Reimplemented from Function1< scalar >.

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

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< scalar >.

Definition at line 57 of file ramp.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), ramp::duration_, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), Function1< scalar >::name(), Foam::nl, ramp::start_, Function1< Type >::writeData(), and Ostream::writeKeyword().

Here is the call graph for this function:

Member Data Documentation

◆ start_

scalar start_

protected

Start-time of the ramp function.

Definition at line 105 of file ramp.H.

Referenced by ramp::writeData().

◆ duration_

scalar duration_

protected

Duration of the ramp function.

Definition at line 108 of file ramp.H.