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

[legend]

Collaboration diagram for Ramp< Function1Type >:

[legend]

Public Member Functions
	Ramp (const word &name, 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
	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 >
	Function1 (const word &name)
	Construct from name. More...

	Function1 (const Function1< scalar > &f1)
	Copy constructor. More...

const word &	name () const
	Return the name of the entry. More...

	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

virtual	~Function1 ()
	Destructor. 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...

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

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 &name, const dictionary &dict)
	Selector. More...

Public Attributes inherited from Function1< scalar >
	Function1

	dictionary

const word &	name

const word const dictionary	name

const word const dictionary &	dict

const word const dictionary	dict

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;
    }

Where:

Property	Description	Required	Default value
`start`	Start time	no	0
`duration`	Duration	yes

See also: Foam::Function1

Source files

Definition at line 97 of file Ramp.H.

Constructor & Destructor Documentation

◆ Ramp()

Ramp	(	const word &	name,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 40 of file Ramp.C.

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

Here is the caller graph for this function:

◆ ~Ramp()

~Ramp ( )

virtual

Destructor.

Definition at line 54 of file Ramp.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ end()

scalar end ( ) const

inlineprotected

Return the end-time of the ramp function.

Definition at line 112 of file Ramp.H.

◆ 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 119 of file Ramp.H.

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

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 126 of file Ramp.H.

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

Here is the caller graph for this function:

◆ value()

virtual scalar value ( const scalar t ) const

pure virtual

Return value for time t.

Implements FieldFunction1< scalar, Function1Type >.

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

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

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write data to dictionary stream.

Implements Function1< scalar >.

Reimplemented in reverseRamp.

Definition at line 61 of file Ramp.C.

Referenced by Ramp< linearRamp >::end(), and reverseRamp::write().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const Ramp< Function1Type > & )

delete

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

Member Data Documentation

◆ start_

scalar start_

protected

Start-time of the ramp function.

Definition at line 106 of file Ramp.H.

◆ duration_

scalar duration_

protected

Duration of the ramp function.

Definition at line 109 of file Ramp.H.

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

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

Detailed Description

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

Constructor & Destructor Documentation

◆ Ramp()

◆ ~Ramp()

Member Function Documentation

◆ end()

◆ linearRamp()

◆ dLinearRampDt()

◆ value()

◆ write()

◆ operator=()

Member Data Documentation

◆ start_

◆ duration_

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