Cantera
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 809 of file Func1.h.

Public Member Functions

 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
Func1 & operator= (const Func1 &right)=delete
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 shared_ptr< Func1 > derivative () const
 Creates a derivative to the current function.
virtual bool isIdentical (shared_ptr< Func1 > other) const
 Routine to determine if two functions are the same.
virtual string write (const string &arg) const
 Write LaTeX string describing function.
double c () const
 Accessor function for the stored constant m_c.
shared_ptr< Func1 > func1_shared () const
 Accessor function for m_f1.
shared_ptr< Func1 > func2_shared () const
 Accessor function for m_f2.
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
shared_ptr< Func1 > m_f1
shared_ptr< Func1 > m_f2

Constructor & Destructor Documentation

◆ Periodic1()

Periodic1 ( shared_ptr< Func1 > f,
double A )
inline

Definition at line 812 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 814 of file Func1.h.

◆ eval()

double eval ( double t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 818 of file Func1.h.


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