Public Member Functions | List of all members
linearRamp Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for linearRamp:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("linearRamp")
 
 linearRamp (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual tmp< Function1< scalar > > clone () const
 Construct and return a clone. More...
 
virtual ~linearRamp ()
 Destructor. More...
 
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 ()
 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 > &de)
 Copy constructor. More...
 
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. 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
 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...
 
- 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

- 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

Linear ramp function starting from 0 and increasing linearRamply 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 linearRamp.H.

Constructor & Destructor Documentation

◆ linearRamp()

linearRamp ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 42 of file linearRamp.C.

Referenced by linearRamp::clone().

Here is the caller graph for this function:

◆ ~linearRamp()

~linearRamp ( )
virtual

Destructor.

Definition at line 53 of file linearRamp.C.

Referenced by linearRamp::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "linearRamp"  )

◆ clone()

virtual tmp<Function1<scalar> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements Function1< scalar >.

Definition at line 80 of file linearRamp.H.

References linearRamp::linearRamp(), linearRamp::value(), and linearRamp::~linearRamp().

Here is the call graph for this function:

◆ value()

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

Return value for time t.

Implements ramp.

Definition at line 59 of file linearRamp.C.

References ramp::linearRamp().

Referenced by linearRamp::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

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