Diff1 Class Reference

Implements the difference of two functions. More...

#include <Func1.h>

Inheritance diagram for Diff1:

Detailed Description

Implements the difference of two functions.

The functor class with type "diff" returns \( f(x) = f_1(x) - f_2(x) \).

Parameters

f1	Functor \( f_1(x) \)
f2	Functor \( f_2(x) \)

Definition at line 480 of file Func1.h.

Public Member Functions
	Diff1 (Func1 &f1, Func1 &f2)
	Diff1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
string	type () const override
	Returns a string describing the type of the function. More...
double	eval (double t) const override
	Evaluate the function. More...
shared_ptr< Func1 >	derivative () const override
	Creates a derivative to the current function. More...
int	order () const override
	Return the order of the function, if it makes sense. More...
string	write (const string &arg) const override
	Write LaTeX string describing function. More...
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. More...
double	operator() (double t) const
	Calls method eval to evaluate the 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)
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...

Additional Inherited Members
Protected Attributes inherited from Func1
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()

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

eval()

double eval ( double  t ) const

inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 503 of file Func1.h.

derivative()

shared_ptr<Func1> derivative ( ) const

inlineoverridevirtual

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 from Func1.

Definition at line 507 of file Func1.h.

order()

int order ( ) const

inlineoverridevirtual

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

Reimplemented from Func1.

Definition at line 511 of file Func1.h.

write()

string write ( const string &  arg ) const

overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 454 of file Func1.cpp.

---

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

• Func1.h
• Func1.cpp