Cantera  2.3.0
Public Member Functions | Protected Attributes | List of all members
Func1 Class Reference

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

#include <Func1.h>

Inheritance diagram for Func1:
[legend]
Collaboration diagram for Func1:
[legend]

Public Member Functions

 Func1 (const Func1 &right)
 
Func1operator= (const Func1 &right)
 
virtual Func1duplicate () const
 Duplicate the current function. More...
 
virtual int ID () const
 
doublereal operator() (doublereal t) const
 Calls method eval to evaluate the function. More...
 
virtual doublereal eval (doublereal t) const
 Evaluate the function. More...
 
virtual Func1derivative () const
 Creates a derivative to the current function. More...
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same. More...
 
virtual doublereal isProportional (TimesConstant1 &other)
 
virtual doublereal isProportional (Func1 &other)
 
virtual std::string write (const std::string &arg) const
 
doublereal c () const
 accessor function for the stored constant More...
 
void setC (doublereal c)
 Function to set the stored constant. More...
 
Func1func1 () const
 accessor function for m_f1 More...
 
Func1func2 () const
 accessor function for m_f2 More...
 
virtual int order () const
 Return the order of the function, if it makes sense. More...
 
Func1func1_dup () const
 
Func1func2_dup () const
 
Func1parent () const
 
void setParent (Func1 *p)
 

Protected Attributes

doublereal m_c
 
Func1m_f1
 
Func1m_f2
 
Func1m_parent
 

Detailed Description

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

Definition at line 41 of file Func1.h.

Member Function Documentation

◆ duplicate()

Func1 & duplicate ( ) const
virtual

Duplicate the current function.

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

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

Definition at line 42 of file Func1.cpp.

Referenced by Product1::derivative(), Ratio1::derivative(), Composite1::derivative(), Sum1::duplicate(), Diff1::duplicate(), Product1::duplicate(), TimesConstant1::duplicate(), PlusConstant1::duplicate(), Ratio1::duplicate(), and Composite1::duplicate().

◆ operator()()

doublereal operator() ( doublereal  t) const

Calls method eval to evaluate the function.

Definition at line 54 of file Func1.cpp.

References Func1::eval().

◆ eval()

doublereal eval ( doublereal  t) const
virtual

◆ 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.

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

Definition at line 65 of file Func1.cpp.

Referenced by Sum1::derivative(), Diff1::derivative(), Product1::derivative(), TimesConstant1::derivative(), PlusConstant1::derivative(), Ratio1::derivative(), and Composite1::derivative().

◆ 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 72 of file Func1.cpp.

References Func1::isIdentical().

Referenced by Func1::isIdentical().

◆ c()

doublereal c ( ) const

accessor function for the stored constant

accessor function for the returned constant

Definition at line 97 of file Func1.cpp.

Referenced by Sin1::derivative().

◆ setC()

void setC ( doublereal  c)

Function to set the stored constant.

Definition at line 103 of file Func1.cpp.

◆ func1()

Func1 & func1 ( ) const

accessor function for m_f1

Definition at line 109 of file Func1.cpp.

◆ func2()

Func1 & func2 ( ) const

accessor function for m_f2

Definition at line 114 of file Func1.cpp.

◆ order()

int order ( ) const
virtual

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

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

Definition at line 119 of file Func1.cpp.


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