Func1 Class Reference

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

#include <Func1.h>

Inheritance diagram for Func1:

Detailed Description

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

Definition at line 74 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)=delete
Func1 &	operator= (const Func1 &right)=delete
virtual string	type () const
	Returns a string describing the type of the function. More...
string	typeName () const
	Returns a string with the class name of the functor. More...
double	operator() (double t) const
	Calls method eval to evaluate the function. More...
virtual double	eval (double t) const
	Evaluate the function. More...
virtual shared_ptr< Func1 >	derivative () const
	Creates a derivative to the current function. More...
shared_ptr< Func1 >	derivative3 () 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 double	isProportional (TimesConstant1 &other)
virtual double	isProportional (Func1 &other)
virtual string	write (const string &arg) const
	Write LaTeX string describing function. More...
double	c () const
	Accessor function for the stored constant. More...
shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1_shared. More...
shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2_shared. More...
virtual int	order () const
	Return the order of the function, if it makes sense. More...

Protected Attributes
double	m_c = 0.0
Func1 *	m_f1 = nullptr
Func1 *	m_f2 = nullptr
shared_ptr< Func1 >	m_f1_shared
shared_ptr< Func1 >	m_f2_shared

Member Function Documentation

type()

virtual string type ( ) const

inlinevirtual

Returns a string describing the type of the function.

Since

New in Cantera 3.0.

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

Definition at line 97 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 16 of file Func1.cpp.

operator()()

double operator()

(

double

t

)

const

Calls method eval to evaluate the function.

Definition at line 22 of file Func1.cpp.

eval()

double eval ( double  t ) const

virtual

Evaluate the function.

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

Definition at line 28 of file Func1.cpp.

derivative()

shared_ptr< Func1 > derivative ( ) const

virtual

Creates a derivative to the current function.

Returns

shared pointer to new derivative function.

Since

Starting in Cantera 3.1, the return type is a shared_ptr.

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

Definition at line 33 of file Func1.cpp.

derivative3()

shared_ptr<Func1> derivative3 ( ) const

inline

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.

Deprecated:

Transitional name for derivative()

Definition at line 125 of file Func1.h.

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

write()

string write ( const string &  arg ) const

virtual

Write LaTeX string describing function.

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

Definition at line 380 of file Func1.cpp.

c()

double c

(

)

const

Accessor function for the stored constant.

accessor function for the returned constant

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

func2_shared()

shared_ptr<Func1> func2_shared ( ) const

inline

Accessor function for m_f2_shared.

Since

New in Cantera 3.0.

Definition at line 152 of file Func1.h.

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

---

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

• Func1.h
• Func1.cpp