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

Inheritance diagram for linearRamp:

[legend]

Collaboration diagram for linearRamp:

[legend]

Public Member Functions
	TypeName ("linearRamp")

	linearRamp (const word &name, const unitConversions &units, const dictionary &dict)
	Construct from name and dictionary. More...

virtual	~linearRamp ()
	Destructor. More...

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

virtual scalar	integral (const scalar t1, const scalar t2) const
	Return the integral between times t1 and t2. More...

void	operator= (const linearRamp &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from Ramp< linearRamp >
	Ramp (const word &name, const unitConversions &units, const dictionary &dict)
	Construct from name and dictionary. More...

virtual	~Ramp ()
	Destructor. More...

virtual void	write (Ostream &os, const unitConversions &units) const
	Write data to dictionary stream. More...

void	operator= (const Ramp< linearRamp > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction1< Type, Function1Type >
	FieldFunction1 (const word &name)
	Construct from name. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

virtual	~FieldFunction1 ()
	Destructor. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of one scalar field. More...

virtual tmp< Field< Type > >	integral (const scalarField &x1, const scalarField &x2) const
	Integrate between two scalar fields. More...

Public Member Functions inherited from Function1< Type >
	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< Type > &f1)
	Copy constructor. More...

virtual	~Function1 ()
	Destructor. More...

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

virtual bool	constant () const
	Is this function guaranteed to be constant? More...

void	operator= (const Function1< Type > &)
	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...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
	Select from Istream. More...

Protected Member Functions inherited from Ramp< linearRamp >
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 inherited from Ramp< linearRamp >
const scalar	start_
	Start-time of the ramp function. More...

const scalar	duration_
	Duration of the ramp function. More...

Protected Attributes inherited from Function1< Type >
const word	name_
	Name of entry. More...

Detailed Description

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

Usage

    <name> linearRamp;
    <name>Coeffs
    {
        start     10;
        duration  20;
    }

or

    <name>
    {
        type      linearRamp;
        start     10;
        duration  20;
    }

or including a constant scaling factor:

    <name>
    {
        type      scale;

        scale
        {
            type        linearRamp;

            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::Function1s::Ramp Foam::Function1s::Scale

Source files

Definition at line 114 of file linearRamp.H.

Constructor & Destructor Documentation

◆ linearRamp()

linearRamp	(	const word &	name,
		const unitConversions &	units,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 41 of file linearRamp.C.

◆ ~linearRamp()

~linearRamp ( )

virtual

Destructor.

Definition at line 54 of file linearRamp.C.

Member Function Documentation

◆ TypeName()

TypeName ( "linearRamp" )

◆ value()

Foam::scalar value ( const scalar t ) const

inlinevirtual

Return value for time t.

Implements Ramp< linearRamp >.

Definition at line 30 of file linearRampI.H.

References Ramp< Function1Type >::linearRamp().

Here is the call graph for this function:

◆ integral()

Foam::scalar integral	(	const scalar	t1,
		const scalar	t2
	)		const

inlinevirtual

Return the integral between times t1 and t2.

Implements FieldFunction1< Type, Function1Type >.

Definition at line 39 of file linearRampI.H.

References Ramp< Function1Type >::linearRamp(), Foam::min(), and Foam::sqr().

Here is the call graph for this function:

◆ operator=()

void operator= ( const linearRamp & )

delete

Disallow default bitwise assignment.

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

src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H
src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.C
src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRampI.H

Public Member Functions

Additional Inherited Members