Cantera  3.1.0a1
Loading...
Searching...
No Matches
Arrhenius1 Class Reference

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 884 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] \).
 
string type () const override
 Returns a string describing the type of the 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)=delete
 
Func1operator= (const Func1 &right)=delete
 
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 shared_ptr< Func1derivative () const
 Creates a derivative to the current function.
 
shared_ptr< Func1derivative3 () 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.
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared.
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2_shared.
 
virtual int order () const
 Return the order of the function, if it makes sense.
 

Protected Attributes

vector< double > m_A
 
vector< double > m_b
 
vector< double > m_E
 
- Protected Attributes inherited from Func1
double m_c = 0.0
 
Func1m_f1 = nullptr
 
Func1m_f2 = nullptr
 
shared_ptr< Func1m_f1_shared
 
shared_ptr< Func1m_f2_shared
 

Constructor & Destructor Documentation

◆ Arrhenius1() [1/2]

Arrhenius1 ( size_t  n,
const double *  c 
)
inline

Definition at line 887 of file Func1.h.

◆ Arrhenius1() [2/2]

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

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

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 907 of file Func1.h.

Member Data Documentation

◆ m_A

vector<double> m_A
protected

Definition at line 916 of file Func1.h.

◆ m_b

vector<double> m_b
protected

Definition at line 916 of file Func1.h.

◆ m_E

vector<double> m_E
protected

Definition at line 916 of file Func1.h.


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