halfCosineRamp Class Reference

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

Inheritance diagram for halfCosineRamp:
Collaboration diagram for halfCosineRamp:

Public Member Functions

 TypeName ("halfCosineRamp")
 
 halfCosineRamp (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual ~halfCosineRamp ()
 Destructor. More...
 
virtual scalar value (const scalar t) const
 Return value for time t. More...
 
void operator= (const halfCosineRamp &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from ramp
 ramp (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual ~ramp ()
 Destructor. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
void operator= (const ramp &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from Function1< scalar >
 Function1 (const word &entryName)
 Construct from entry name. More...
 
 Function1 (const Function1< scalar > &f1)
 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 ()
 Destructor. More...
 
const wordname () 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=0
 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=0
 Integrate between two (scalar) values. More...
 
void operator= (const Function1< scalar > &)=delete
 Disallow default bitwise 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...
 

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)
 Selector. More...
 
- Public Attributes inherited from Function1< scalar >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionary entryName
 
const word const dictionarydict
 
const word const dictionary dict
 
- Protected Member Functions inherited from ramp
scalar linearRamp (const scalar t) const
 Simple linear ramp function. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initializing count to 0. 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

Half-cosine 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 54 of file halfCosineRamp.H.

Constructor & Destructor Documentation

◆ halfCosineRamp()

halfCosineRamp ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 42 of file halfCosineRamp.C.

◆ ~halfCosineRamp()

~halfCosineRamp ( )
virtual

Destructor.

Definition at line 53 of file halfCosineRamp.C.

Member Function Documentation

◆ TypeName()

TypeName ( "halfCosineRamp"  )

◆ value()

Foam::scalar value ( const scalar  t) const
inlinevirtual

Return value for time t.

Implements ramp.

Definition at line 32 of file halfCosineRampI.H.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const halfCosineRamp )
delete

Disallow default bitwise assignment.


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