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

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

Public Member Functions inherited from Function1< scalar >
	Function1 (const word &entryName)
	Construct from entry name. More...

	Function1 (const Function1< scalar > &f1)
	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 ()=default
	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...

Protected Member Functions
scalar	linearRamp (const scalar t) const
	Simple linear ramp function. 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
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=word::null)
	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 98 of file ramp.H.

Constructor & Destructor Documentation

◆ ramp()

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

Construct from entry name and dictionary.

Definition at line 40 of file ramp.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~ramp()

~ramp ( )

virtual

Destructor.

Definition at line 53 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 114 of file ramp.H.

◆ value()

virtual 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 59 of file ramp.C.

References Ostream::beginBlock(), token::END_STATEMENT, Ostream::endBlock(), Foam::name(), Foam::nl, Function1< Type >::writeData(), and 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 107 of file ramp.H.

◆ duration_

scalar duration_

protected

Duration of the ramp function.

Definition at line 110 of file ramp.H.

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

src/OpenFOAM/primitives/functions/Function1/ramp/ramp.H
src/OpenFOAM/primitives/functions/Function1/ramp/ramp.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members