| Cantera 3.0.0

Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Func1 Class Reference
Numerical Utilities » Functor Objects

Base class for 'functor' classes that evaluate a function of one variable. More...

`#include <Func1.h>`

Inheritance diagram for Func1:
[legend]

## Detailed Description

Base class for 'functor' classes that evaluate a function of one variable.

Definition at line 95 of file Func1.h.

## 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

## Constructor & Destructor Documentation

## ◆ Func1() [1/3]

Func1 | ( | shared_ptr< Func1 > | f1,
|  | shared_ptr< Func1 > | f2
| ) |  |
| inline

Definition at line 100 of file Func1.h.

## ◆ Func1() [2/3]

Func1 | ( | shared_ptr< Func1 > | f1,
|  | double | A
| ) |  |
| inline

Definition at line 107 of file Func1.h.

## ◆ Func1() [3/3]

Func1 | ( | const Func1 & | right | ) |

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 16 of file Func1.cpp.

## Member Function Documentation

## ◆ operator=()

Func1 & operator= | ( | const Func1 & | right | ) |

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 24 of file Func1.cpp.

## ◆ duplicate()

Func1 & duplicate | ( |  | ) | const
| virtual

Duplicate the current function.

This duplicates the current function, returning a reference to the newly created function.

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Reimplemented in Sin1, Cos1, Exp1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, Composite1, Gaussian, Poly1, Fourier1, Arrhenius1, and Periodic1.

Definition at line 36 of file Func1.cpp.

## ◆ ID()

int ID | ( |  | ) | const
| virtual

Deprecated:
  To be removed after Cantera 3.0. Replaced by type.

Reimplemented in Sin1, Cos1, Exp1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.

Definition at line 44 of file Func1.cpp.

## ◆ type()

virtual string type | ( |  | ) | const
| inline virtual

Returns a string describing the type of the function.

Since
  New in Cantera 3.0.

Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, Composite1, Gaussian1, Poly1, Fourier1, Arrhenius1, and Periodic1.

Definition at line 132 of file Func1.h.

## ◆ typeName()

string typeName | ( |  | ) | const

Returns a string with the class name of the functor.

Since
  New in Cantera 3.0.

Definition at line 49 of file Func1.cpp.

## ◆ operator()()

double operator() | ( | double | t | ) | const

Calls method eval to evaluate the function.

Definition at line 55 of file Func1.cpp.

## ◆ eval()

double eval | ( | 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.

Definition at line 61 of file Func1.cpp.

## ◆ derivative()

Func1 & derivative | ( |  | ) | const
| virtual

Creates a derivative to the current function.

This will create a new derivative function and return a reference to the function.

Deprecated:
  To be changed after Cantera 3.0; for new behavior, see derivative3.

Reimplemented in Sin1, Cos1, Exp1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.

Definition at line 66 of file Func1.cpp.

## ◆ derivative3()

shared_ptr< Func1 > derivative3 | ( |  | ) | const
| virtual

Creates a derivative to the current function.

This will create a new derivative function

Returns
  shared pointer to new derivative function.

Since
  New in Cantera 3.0.

Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.

Definition at line 75 of file Func1.cpp.

## ◆ isIdentical()

bool isIdentical | ( | Func1 & | other | ) | const

Routine to determine if two functions are the same.

Two functions are the same if they are the same function. This means that the ID and stored constant is the same. This means that the m_f1 and m_f2 are identical if they are non-null.

Definition at line 81 of file Func1.cpp.

## ◆ isProportional() [1/2]

double isProportional | ( | TimesConstant1 & | other | ) |
| virtual

Definition at line 869 of file Func1.cpp.

## ◆ isProportional() [2/2]

double isProportional | ( | Func1 & | other | ) |
| virtual

Definition at line 876 of file Func1.cpp.

## ◆ write()

string write | ( | const string & | arg | ) | const
| virtual

Write LaTeX string describing function.

Reimplemented in Sin1, Cos1, Exp1, Log1, Pow1, Tabulated1, Const1, Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.

Definition at line 618 of file Func1.cpp.

## ◆ c()

double c | ( |  | ) | const

Accessor function for the stored constant.

accessor function for the returned constant

Definition at line 106 of file Func1.cpp.

## ◆ setC()

void setC | ( | double | c | ) |

Function to set the stored constant.

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 112 of file Func1.cpp.

## ◆ func1()

Func1 & func1 | ( |  | ) | const

accessor function for m_f1

Deprecated:
  To be removed after Cantera 3.0; replaced by func1_shared().

Definition at line 118 of file Func1.cpp.

## ◆ func1_shared()

shared_ptr< Func1 > func1_shared | ( |  | ) | const
| inline

Accessor function for m_f1_shared.

Since
  New in Cantera 3.0.

Definition at line 189 of file Func1.h.

## ◆ func2()

Func1 & func2 | ( |  | ) | const

accessor function for m_f2

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 123 of file Func1.cpp.

## ◆ func2_shared()

shared_ptr< Func1 > func2_shared | ( |  | ) | const
| inline

Accessor function for m_f2_shared.

Since
  New in Cantera 3.0.

Definition at line 199 of file Func1.h.

## ◆ order()

int order | ( |  | ) | const
| virtual

Return the order of the function, if it makes sense.

Reimplemented in Sum1, Diff1, Product1, TimesConstant1, PlusConstant1, Ratio1, and Composite1.

Definition at line 128 of file Func1.cpp.

## ◆ func1_dup()

Func1 & func1_dup | ( |  | ) | const

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 133 of file Func1.cpp.

## ◆ func2_dup()

Func1 & func2_dup | ( |  | ) | const

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 138 of file Func1.cpp.

## ◆ parent()

Func1 * parent | ( |  | ) | const

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 143 of file Func1.cpp.

## ◆ setParent()

void setParent | ( | Func1 * | p | ) |

Deprecated:
  To be removed after Cantera 3.0. Only used by deprecated methods.

Definition at line 148 of file Func1.cpp.

## Member Data Documentation

## ◆ m_c

double m_c = 0.0
| protected

Definition at line 219 of file Func1.h.

## ◆ m_f1

Func1* m_f1 = nullptr
| protected

Definition at line 220 of file Func1.h.

## ◆ m_f2

Func1* m_f2 = nullptr
| protected

Definition at line 221 of file Func1.h.

## ◆ m_parent

Func1* m_parent = nullptr
| protected

Definition at line 222 of file Func1.h.

## ◆ m_f1_shared

shared_ptr<Func1> m_f1_shared
| protected

Definition at line 224 of file Func1.h.

## ◆ m_f2_shared

shared_ptr<Func1> m_f2_shared
| protected

Definition at line 225 of file Func1.h.

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

- Func1.h
- Func1.cpp