Cantera  2.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
Rate1< R > Class Template Reference

This rate coefficient manager supports one parameterization of the rate constant of any type. More...

#include <RateCoeffMgr.h>

Public Member Functions

size_t install (size_t rxnNumber, const ReactionData &rdata)
 Install a rate coefficient calculator. More...
 
void install (size_t rxnNumber, const R &rate)
 Install a rate coefficient calculator. More...
 
void replace (size_t rxnNumber, const R &rate)
 Replace an existing rate coefficient calculator. More...
 
void update_C (const doublereal *c)
 Update the concentration-dependent parts of the rate coefficient, if any. More...
 
void update (doublereal T, doublereal logT, doublereal *values)
 Write the rate coefficients into array values. More...
 
size_t nReactions () const
 

Protected Attributes

std::vector< R > m_rates
 
std::vector< size_t > m_rxn
 
std::map< size_t, size_t > m_indices
 map reaction number to index in m_rxn / m_rates More...
 

Detailed Description

template<class R>
class Cantera::Rate1< R >

This rate coefficient manager supports one parameterization of the rate constant of any type.

Definition at line 20 of file RateCoeffMgr.h.

Member Function Documentation

size_t install ( size_t  rxnNumber,
const ReactionData rdata 
)
inline

Install a rate coefficient calculator.

Parameters
rxnNumberthe reaction number
rdatarate coefficient specification for the reaction

Definition at line 33 of file RateCoeffMgr.h.

void install ( size_t  rxnNumber,
const R &  rate 
)
inline

Install a rate coefficient calculator.

Parameters
rxnNumberthe reaction number
raterate coefficient specification for the reaction

Definition at line 54 of file RateCoeffMgr.h.

void replace ( size_t  rxnNumber,
const R &  rate 
)
inline

Replace an existing rate coefficient calculator.

Definition at line 61 of file RateCoeffMgr.h.

void update_C ( const doublereal *  c)
inline

Update the concentration-dependent parts of the rate coefficient, if any.

Used by class SurfaceArrhenius to compute coverage-dependent * modifications to the Arrhenius parameters. The array c should contain whatever data the particular rate coefficient class needs to update its rates. Note that this method does not return anything. To get the updated rates, method update must be called after the call to update_C.

Definition at line 76 of file RateCoeffMgr.h.

void update ( doublereal  T,
doublereal  logT,
doublereal *  values 
)
inline

Write the rate coefficients into array values.

Each calculator writes one entry in values, at the location specified by the reaction number when it was installed. Note that nothing will be done for reactions that have constant rates. The array values should be preloaded with the constant rate coefficients.

Definition at line 90 of file RateCoeffMgr.h.

Member Data Documentation

std::map<size_t, size_t> m_indices
protected

map reaction number to index in m_rxn / m_rates

Definition at line 106 of file RateCoeffMgr.h.

Referenced by Rate1< Cantera::Plog >::install(), and Rate1< Cantera::Plog >::replace().


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