Cantera  3.1.0a1
Loading...
Searching...
No Matches

Implements a periodic function. More...

#include <Func1.h>

Inheritance diagram for Periodic1:
[legend]

Detailed Description

Implements a periodic function.

Takes any function and makes it periodic with period \( T \).

Parameters
fFunctor to be made periodic
TPeriod

Definition at line 926 of file Func1.h.

Public Member Functions

 Periodic1 (Func1 &f, double T)
 
 Periodic1 (shared_ptr< Func1 > f, double A)
 
string type () const override
 Returns a string describing the type of the function.
 
double eval (double t) const override
 Evaluate the function.
 
- Public Member Functions inherited from Func1
 Func1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 
 Func1 (shared_ptr< Func1 > f1, double A)
 
 Func1 (const Func1 &right)=delete
 
Func1operator= (const Func1 &right)=delete
 
virtual string type () const
 Returns a string describing the type of the function.
 
string typeName () const
 Returns a string with the class name of the functor.
 
double operator() (double t) const
 Calls method eval to evaluate the function.
 
virtual double eval (double t) const
 Evaluate the function.
 
virtual shared_ptr< Func1derivative () const
 Creates a derivative to the current function.
 
shared_ptr< Func1derivative3 () const
 Creates a derivative to the current function.
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same.
 
virtual double isProportional (TimesConstant1 &other)
 
virtual double isProportional (Func1 &other)
 
virtual string write (const string &arg) const
 Write LaTeX string describing function.
 
double c () const
 Accessor function for the stored constant.
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared.
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2_shared.
 
virtual int order () const
 Return the order of the function, if it makes sense.
 

Additional Inherited Members

- Protected Attributes inherited from Func1
double m_c = 0.0
 
Func1m_f1 = nullptr
 
Func1m_f2 = nullptr
 
shared_ptr< Func1m_f1_shared
 
shared_ptr< Func1m_f2_shared
 

Constructor & Destructor Documentation

◆ Periodic1() [1/2]

Periodic1 ( Func1 f,
double  T 
)
inline

Definition at line 929 of file Func1.h.

◆ Periodic1() [2/2]

Periodic1 ( shared_ptr< Func1 f,
double  A 
)
inline

Definition at line 934 of file Func1.h.

◆ ~Periodic1()

~Periodic1 ( )
inlineoverride

Definition at line 940 of file Func1.h.

Member Function Documentation

◆ type()

string type ( ) const
inlineoverridevirtual

Returns a string describing the type of the function.

Since
New in Cantera 3.0.

Reimplemented from Func1.

Definition at line 936 of file Func1.h.

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 946 of file Func1.h.


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