Cantera  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Arrhenius1 Class Reference
Numerical Utilities » Functor Objects » Advanced Functors

Implements a sum of Arrhenius terms. More...

#include <Func1.h>

Inheritance diagram for Arrhenius1:
[legend]

Detailed Description

Implements a sum of Arrhenius terms.

The functor class with type "Arrhenius" returns

\[ f(T) = \sum_{n=1}^N A_n T^b_n \exp(-E_n/T) \]

Definition at line 1290 of file Func1.h.

Public Member Functions

 Arrhenius1 (size_t n, const double *c)
 
 Arrhenius1 (const vector< double > &params)
 Constructor uses \( 3 n \) parameters in the following order: \( [A_1, b_1, E_1, A_2, b_2, E_2, \dots, A_n, b_n, E_n] \).
 
 Arrhenius1 (const Arrhenius1 &b)
 
Arrhenius1 & operator= (const Arrhenius1 &right)
 
string type () const override
 Returns a string describing the type of the function.
 
Func1 & duplicate () const override
 Duplicate the current function.
 
double eval (double t) const override
 Evaluate the 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)
 
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

vector< double > m_A
 
vector< double > m_b
 
vector< double > m_E
 
- Protected Attributes inherited from Func1
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

◆ Arrhenius1() [1/3]

Arrhenius1 ( size_t  n,
const double *  c 
)
inline

Definition at line 1293 of file Func1.h.

◆ Arrhenius1() [2/3]

Arrhenius1 ( const vector< double > &  params)

Constructor uses \( 3 n \) parameters in the following order: \( [A_1, b_1, E_1, A_2, b_2, E_2, \dots, A_n, b_n, E_n] \).

Definition at line 407 of file Func1.cpp.

◆ Arrhenius1() [3/3]

Arrhenius1 ( const Arrhenius1 &  b)
inline

Definition at line 1309 of file Func1.h.

Member Function Documentation

◆ operator=()

Arrhenius1 & operator= ( const Arrhenius1 &  right)
inline

Definition at line 1314 of file Func1.h.

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

◆ duplicate()

Func1 & duplicate ( ) const
overridevirtual

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

Definition at line 604 of file Func1.cpp.

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 1332 of file Func1.h.

Member Data Documentation

◆ m_A

vector<double> m_A
protected

Definition at line 1341 of file Func1.h.

◆ m_b

vector<double> m_b
protected

Definition at line 1341 of file Func1.h.

◆ m_E

vector<double> m_E
protected

Definition at line 1341 of file Func1.h.

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