Cantera  2.1.2
Public Member Functions | List of all members
Falloff Class Reference

Base class for falloff function calculators. More...

#include <FalloffFactory.h>

Inheritance diagram for Falloff:
[legend]

Public Member Functions

 Falloff ()
 Default constructor is empty. More...
 
virtual ~Falloff ()
 default destructor is empty More...
 
virtual void init (const vector_fp &c)
 Initialize. More...
 
virtual void updateTemp (doublereal T, doublereal *work) const
 Update the temperature-dependent portions of the falloff function, if any. More...
 
virtual doublereal F (doublereal pr, const doublereal *work) const
 The falloff function. More...
 
virtual size_t workSize ()
 The size of the work array required. More...
 

Detailed Description

Base class for falloff function calculators.

Each instance of a subclass of Falloff computes one falloff function. This base class implements the trivial falloff function F = 1.0.

Definition at line 36 of file FalloffFactory.h.

Constructor & Destructor Documentation

Falloff ( )
inline

Default constructor is empty.

Definition at line 40 of file FalloffFactory.h.

virtual ~Falloff ( )
inlinevirtual

default destructor is empty

Definition at line 43 of file FalloffFactory.h.

Member Function Documentation

virtual void init ( const vector_fp c)
inlinevirtual

Initialize.

Must be called before any other method is invoked.

Parameters
cVector of coefficients of the parameterization. The number and meaning of these coefficients is subclass-dependent.

Reimplemented in WF93, SRI5, SRI3, Troe4, and Troe3.

Definition at line 51 of file FalloffFactory.h.

Referenced by FalloffFactory::newFalloff().

virtual void updateTemp ( doublereal  T,
doublereal *  work 
) const
inlinevirtual

Update the temperature-dependent portions of the falloff function, if any.

This method evaluates temperature-dependent intermediate results and stores them in the 'work' array. If not overloaded, the default behavior is to do nothing.

Parameters
TTemperature [K].
workstorage space for intermediate results.

Reimplemented in WF93, SRI5, SRI3, Troe4, and Troe3.

Definition at line 61 of file FalloffFactory.h.

virtual doublereal F ( doublereal  pr,
const doublereal *  work 
) const
inlinevirtual

The falloff function.

This is defined so that the rate coefficient is

\[ k = F(Pr)\frac{Pr}{1 + Pr}. \]

Here \( Pr \) is the reduced pressure, defined by

\[ Pr = \frac{k_0 [M]}{k_\infty}. \]

Parameters
prreduced pressure (dimensionless).
workarray of size workSize() containing cached temperature-dependent intermediate results from a prior call to updateTemp.
Returns
Returns the value of the falloff function \( F \) defined above

Reimplemented in WF93, SRI5, SRI3, Troe4, and Troe3.

Definition at line 82 of file FalloffFactory.h.

virtual size_t workSize ( )
inlinevirtual

The size of the work array required.

Reimplemented in WF93, SRI5, SRI3, Troe4, and Troe3.

Definition at line 87 of file FalloffFactory.h.

Referenced by FalloffMgr::install().


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