ramp Class Reference

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:

Collaboration diagram for ramp:

Public Member Functions
	ramp (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
virtual	~ramp ()=default
virtual void	userTimeToTime (const Time &t)
virtual scalar	value (const scalar t) const =0
virtual void	writeData (Ostream &os) const
void	writeEntries (Ostream &os) const
Public Member Functions inherited from Function1< scalar >
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Function1 (const Function1< Type > &rhs)
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
virtual tmp< Function1< Type > >	clone () const=0
virtual	~Function1 ()=default
virtual bool	constant () const
virtual tmp< Field< Type > >	value (const scalarField &x) const
virtual Type	integrate (const scalar x1, const scalar x2) const
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
void	writeEntries (Ostream &os) const

Protected Member Functions
scalar	linearRamp (const scalar t) const
Protected Member Functions inherited from Function1< scalar >
void	operator= (const Function1< Type > &)=delete

Protected Attributes
scalar	start_
scalar	duration_

Additional Inherited Members
Public Types inherited from Function1< scalar >
typedef Type	returnType
Static Public Member Functions inherited from Function1< scalar >
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
static autoPtr< Function1< Type > >	NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
Public Attributes inherited from Function1< scalar >
	Function1
	dictionary
const word &	entryName
const word const dictionary const objectRegistry	entryName
const word const dictionary &	dict
const word const dictionary const objectRegistry	dict
const word const dictionary const objectRegistry *	obrPtr
const word const dictionary const objectRegistry	obrPtr

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

• ramp.H
• ramp.C

Definition at line 95 of file ramp.H.

Constructor & Destructor Documentation

ramp()

ramp	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = nullptr
	)

Definition at line 34 of file ramp.C.

References dict, and Foam::read().

Here is the call graph for this function:

~ramp()

virtual ~ramp ( )

virtualdefault

Member Function Documentation

linearRamp()

scalar linearRamp ( const scalar  t ) const

inlineprotected

Definition at line 111 of file ramp.H.

References ramp::duration_, Foam::max(), Foam::min(), and ramp::start_.

Here is the call graph for this function:

userTimeToTime()

void userTimeToTime ( const Time &  t )

virtual

Definition at line 55 of file ramp.C.

References TimeState::userTimeToTime().

Here is the call graph for this function:

value()

virtual scalar value ( const scalar  t ) const

pure virtual

Reimplemented from Function1< scalar >.

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

writeData()

void writeData ( Ostream &  os ) const

virtual

Reimplemented from Function1< scalar >.

Definition at line 62 of file ramp.C.

References Foam::name(), os(), and Function1::writeData().

Here is the call graph for this function:

writeEntries()

void writeEntries

(

Ostream &

os

)

const

Definition at line 48 of file ramp.C.

References os().

Here is the call graph for this function:

Member Data Documentation

start_

scalar start_

protected

Definition at line 104 of file ramp.H.

Referenced by ramp::linearRamp().

duration_

scalar duration_

protected

Definition at line 107 of file ramp.H.

Referenced by ramp::linearRamp().

---

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