Cantera  2.3.0
Public Member Functions | Protected Attributes | List of all members

A falloff manager that implements any set of falloff functions. More...

#include <FalloffMgr.h>

Collaboration diagram for FalloffMgr:
[legend]

Public Member Functions

 FalloffMgr ()
 Constructor. More...
 
void install (size_t rxn, int reactionType, shared_ptr< Falloff > f)
 Install a new falloff function calculator. More...
 
void replace (size_t rxn, shared_ptr< Falloff > f)
 
size_t workSize ()
 Size of the work array required to store intermediate results. More...
 
void updateTemp (doublereal t, doublereal *work)
 Update the cached temperature-dependent intermediate results for all installed falloff functions. More...
 
void pr_to_falloff (doublereal *values, const doublereal *work)
 Given a vector of reduced pressures for each falloff reaction, replace each entry by the value of the falloff function. More...
 

Protected Attributes

std::vector< size_t > m_rxn
 
std::vector< shared_ptr< Falloff > > m_falloff
 
FalloffFactorym_factory
 
vector_int m_loc
 
std::vector< vector_fp::difference_type > m_offset
 
size_t m_worksize
 
vector_int m_reactionType
 Distinguish between falloff and chemically activated reactions. More...
 
std::map< size_t, size_t > m_indices
 map of external reaction index to local index More...
 

Detailed Description

A falloff manager that implements any set of falloff functions.

Definition at line 22 of file FalloffMgr.h.

Constructor & Destructor Documentation

◆ FalloffMgr()

FalloffMgr ( )
inline

Constructor.

Definition at line 26 of file FalloffMgr.h.

References FalloffFactory::factory().

Member Function Documentation

◆ install()

void install ( size_t  rxn,
int  reactionType,
shared_ptr< Falloff f 
)
inline

Install a new falloff function calculator.

Definition at line 39 of file FalloffMgr.h.

References FalloffMgr::m_indices, and FalloffMgr::m_reactionType.

◆ replace()

void replace ( size_t  rxn,
shared_ptr< Falloff f 
)
inline

Replace an existing falloff function calculator

Parameters
rxnExternal reaction index
fNew falloff function, of the same kind as the existing one

Definition at line 54 of file FalloffMgr.h.

References FalloffMgr::m_indices.

◆ workSize()

size_t workSize ( )
inline

Size of the work array required to store intermediate results.

Definition at line 59 of file FalloffMgr.h.

◆ updateTemp()

void updateTemp ( doublereal  t,
doublereal *  work 
)
inline

Update the cached temperature-dependent intermediate results for all installed falloff functions.

Parameters
tTemperature [K].
workWork array. Must be dimensioned at least workSize().

Definition at line 69 of file FalloffMgr.h.

◆ pr_to_falloff()

void pr_to_falloff ( doublereal *  values,
const doublereal *  work 
)
inline

Given a vector of reduced pressures for each falloff reaction, replace each entry by the value of the falloff function.

Definition at line 79 of file FalloffMgr.h.

References Cantera::FALLOFF_RXN, and FalloffMgr::m_reactionType.

Member Data Documentation

◆ m_reactionType

vector_int m_reactionType
protected

Distinguish between falloff and chemically activated reactions.

Definition at line 103 of file FalloffMgr.h.

Referenced by FalloffMgr::install(), and FalloffMgr::pr_to_falloff().

◆ m_indices

std::map<size_t, size_t> m_indices
protected

map of external reaction index to local index

Definition at line 106 of file FalloffMgr.h.

Referenced by FalloffMgr::install(), and FalloffMgr::replace().


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