Quarter-sine ramp function starting from 0 and increasing to 1 from start over the duration and remaining at 1 thereafter. More...

Inheritance diagram for quarterSineRamp:

[legend]

Collaboration diagram for quarterSineRamp:

[legend]

Public Member Functions
	TypeName ("quarterSineRamp")
	Runtime type information. More...

	quarterSineRamp (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

virtual	~quarterSineRamp ()=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, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

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

virtual void	userTimeToTime (const Time &t)
	Convert time. More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Public Member Functions inherited from Function1< scalar >
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

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

	Function1 (const Function1< scalar > &rhs)
	Copy construct. 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...

virtual bool	constant () const
	Is value constant (i.e. independent of x) 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...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. 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, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection. More...

static autoPtr< Function1< scalar > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static refPtr< Function1< scalar > >	New (HashPtrTable< Function1< scalar >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)

static autoPtr< Function1< scalar > >	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)
	Compatibility selector, with fallback redirection. More...

static autoPtr< Function1< scalar > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. More...

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

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

Detailed Description

Quarter-sine ramp function starting from 0 and increasing to 1 from start over the duration and remaining at 1 thereafter.

See also: Foam::Function1Types::ramp

Source files

Definition at line 57 of file quarterSineRamp.H.

Constructor & Destructor Documentation

◆ quarterSineRamp()

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

Construct from entry name, dictionary and optional registry.

Definition at line 45 of file quarterSineRamp.C.

◆ ~quarterSineRamp()

virtual ~quarterSineRamp ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "quarterSineRamp" )

Runtime type information.

◆ value()

Foam::scalar value ( const scalar t ) const

inlinevirtual

Return value for time t.

Implements ramp.

Definition at line 34 of file quarterSineRampI.H.

References Foam::constant::mathematical::pi(), and Foam::sin().

Here is the call graph for this function:

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

src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.H
src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.C
src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRampI.H

Public Member Functions