|
Cantera
3.0.0
|
Base class for 'functor' classes that evaluate a function of one variable. More...
#include <Func1.h>
Base class for 'functor' classes that evaluate a function of one variable.
Public Member Functions | |
| Func1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2) | |
| Func1 (shared_ptr< Func1 > f1, double A) | |
| Func1 (const Func1 &right) | |
| Func1 & | operator= (const Func1 &right) |
| virtual Func1 & | duplicate () const |
| Duplicate the current function. | |
| virtual int | ID () const |
| 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 Func1 & | derivative () const |
| Creates a derivative to the current function. | |
| virtual shared_ptr< Func1 > | derivative3 () 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. | |
| void | setC (double c) |
| Function to set the stored constant. | |
| Func1 & | func1 () const |
| accessor function for m_f1 | |
| shared_ptr< Func1 > | func1_shared () const |
| Accessor function for m_f1_shared. | |
| Func1 & | func2 () const |
| accessor function for m_f2 | |
| shared_ptr< Func1 > | func2_shared () const |
| Accessor function for m_f2_shared. | |
| virtual int | order () const |
| Return the order of the function, if it makes sense. | |
| Func1 & | func1_dup () const |
| Func1 & | func2_dup () const |
| Func1 * | parent () const |
| void | setParent (Func1 *p) |
Protected Attributes | |
| double | m_c = 0.0 |
| Func1 * | m_f1 = nullptr |
| Func1 * | m_f2 = nullptr |
| Func1 * | m_parent = nullptr |
| shared_ptr< Func1 > | m_f1_shared |
| shared_ptr< Func1 > | m_f2_shared |
|
virtual |
Duplicate the current function.
This duplicates the current function, returning a reference to the newly created function.
Reimplemented in Sin1, Cos1, Exp1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, Composite1, Gaussian, Poly1, Fourier1, Arrhenius1, and Periodic1.
|
virtual |
Reimplemented in Sin1, Cos1, Exp1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.
|
inlinevirtual |
Returns a string describing the type of the function.
Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, Composite1, Gaussian1, Poly1, Fourier1, Arrhenius1, and Periodic1.
| string typeName | ( | ) | const |
| double operator() | ( | double | t | ) | const |
|
virtual |
Evaluate the function.
Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, Composite1, Gaussian1, Poly1, Fourier1, Arrhenius1, and Periodic1.
|
virtual |
Creates a derivative to the current function.
This will create a new derivative function and return a reference to the function.
Reimplemented in Sin1, Cos1, Exp1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.
|
virtual |
Creates a derivative to the current function.
This will create a new derivative function
Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.
| bool isIdentical | ( | Func1 & | other | ) | const |
|
virtual |
|
virtual |
Write LaTeX string describing function.
Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.
| double c | ( | ) | const |
| void setC | ( | double | c | ) |
Function to set the stored constant.
| Func1 & func1 | ( | ) | const |
accessor function for m_f1
|
inline |
| Func1 & func2 | ( | ) | const |
accessor function for m_f2
|
inline |
|
virtual |
Return the order of the function, if it makes sense.
Reimplemented in Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.
| Func1 & func1_dup | ( | ) | const |
| Func1 & func2_dup | ( | ) | const |
| Func1 * parent | ( | ) | const |
| void setParent | ( | Func1 * | p | ) |