Linear ramp function starting from 0 and increasing linearly to 1 from start over the duration and remaining at 1 thereafter. More...

Inheritance diagram for linearRamp:

Collaboration diagram for linearRamp:

Public Member Functions
	TypeName ("linearRamp")

	linearRamp (const word &entryName, const dictionary &dict)
	Construct from entry name and dictionary. More...

virtual	~linearRamp ()=default
	Destructor. More...

virtual scalar	value (const scalar t) const
	Return value for time t. More...

Public Member Functions inherited from ramp
	ramp (const word &entryName, const dictionary &dict)
	Construct from entry name and dictionary. More...

virtual	~ramp ()=default
	Destructor. 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 > &rhs)
	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...

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

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

Detailed Description

Linear ramp function starting from 0 and increasing linearly to 1 from start over the duration and remaining at 1 thereafter.

Source files

Definition at line 57 of file linearRamp.H.

Constructor & Destructor Documentation

Construct from entry name and dictionary.

Definition at line 44 of file linearRamp.C.

virtual ~linearRamp ( )

virtualdefault

Destructor.

TypeName ( "linearRamp" )

Foam::scalar value ( const scalar t ) const

inlinevirtual

Return value for time t.

Implements ramp.

Definition at line 33 of file linearRampI.H.

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