Exp1 Class Reference

Implements the exp() (exponential) function. More...

#include <Func1.h>

Inheritance diagram for Exp1:

Detailed Description

Implements the exp() (exponential) function.

The functor class with type "exp" returns \( f(x) = \exp(a x) \).

Parameters

a	Factor (default=1.0)

Definition at line 244 of file Func1.h.

Public Member Functions
	Exp1 (double a=1.0)
	Exp1 (const vector< double > &params)
	Constructor uses single parameter (exponent factor)
string	write (const string &arg) const override
	Write LaTeX string describing function.
string	type () const override
	Returns a string describing the type of the function.
double	eval (double t) const override
	Evaluate the function.
shared_ptr< Func1 >	derivative () const override
	Creates a derivative to the current function.
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.
double	operator() (double t) const
	Calls method eval to evaluate the function.
virtual bool	isIdentical (shared_ptr< Func1 > other) const
	Routine to determine if two functions are the same.
double	c () const
	Accessor function for the stored constant m_c.
shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1.
shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2.
virtual int	order () const
	Return the order of the function, if it makes sense.

Additional Inherited Members
Protected Attributes inherited from Func1
double	m_c = 0.0
shared_ptr< Func1 >	m_f1
shared_ptr< Func1 >	m_f2

Constructor & Destructor Documentation

Exp1() [1/2]

Exp1 ( double a = 1.0 )

inline

Definition at line 247 of file Func1.h.

Exp1() [2/2]

Exp1

(

const vector< double > &

params

)

Constructor uses single parameter (exponent factor)

Definition at line 128 of file Func1.cpp.

Member Function Documentation

write()

string write ( const string & arg ) const

overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 146 of file Func1.cpp.

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

eval()

double eval ( double t ) const

inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 260 of file Func1.h.

derivative()

shared_ptr< Func1 > derivative ( ) const

overridevirtual

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

---

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

• Func1.h
• Func1.cpp