Cantera  3.1.0a1
ArrheniusData Struct Reference

Data container holding shared data specific to ArrheniusRate. More...

#include <Arrhenius.h>

Inheritance diagram for ArrheniusData:
[legend]

Detailed Description

Data container holding shared data specific to ArrheniusRate.

The data container ArrheniusData holds precalculated data common to all ArrheniusRate objects.

Definition at line 29 of file Arrhenius.h.

Public Member Functions

bool update (const ThermoPhase &phase, const Kinetics &kin) override
 Update data container based on thermodynamic phase state. More...
 
virtual void update (double T)
 Update data container based on temperature T More...
 
virtual void update (double T, double extra)
 Update data container based on temperature T and an extra parameter. More...
 
virtual void update (double T, const vector< double > &extra)
 Update data container based on temperature T and a vector parameter extra More...
 
virtual bool update (const ThermoPhase &phase, const Kinetics &kin)=0
 Update data container based on thermodynamic phase state. More...
 
- Public Member Functions inherited from ReactionData
virtual void update (double T)
 Update data container based on temperature T More...
 
virtual void update (double T, double extra)
 Update data container based on temperature T and an extra parameter. More...
 
virtual void update (double T, const vector< double > &extra)
 Update data container based on temperature T and a vector parameter extra More...
 
void perturbTemperature (double deltaT)
 Perturb temperature of data container. More...
 
virtual void restore ()
 Restore data container after a perturbation. More...
 
virtual void resize (size_t nSpecies, size_t nReactions, size_t nPhases)
 Update number of species, reactions and phases. More...
 
virtual void invalidateCache ()
 Force shared data and reaction rates to be updated next time. More...
 

Additional Inherited Members

- Public Attributes inherited from ReactionData
double temperature = 1.0
 temperature More...
 
double logT = 0.0
 logarithm of temperature More...
 
double recipT = 1.0
 inverse of temperature More...
 
- Protected Attributes inherited from ReactionData
double m_temperature_buf = -1.0
 buffered temperature More...
 

Member Function Documentation

◆ update() [1/5]

bool update ( const ThermoPhase phase,
const Kinetics kin 
)
overridevirtual

Update data container based on thermodynamic phase state.

This update mechanism is used by Kinetics reaction rate evaluators.

Returns
A boolean element indicating whether the evalFromStruct method needs to be called (assuming previously-calculated values were cached)

Implements ReactionData.

Definition at line 146 of file Arrhenius.cpp.

◆ update() [2/5]

virtual void update
inline

Update data container based on temperature T

Only used in conjunction with MultiRateBase::evalSingle / ReactionRate::eval. This method allows for testing of a reaction rate expression outside of Kinetics reaction rate evaluators.

Definition at line 36 of file ReactionData.h.

◆ update() [3/5]

virtual void update
inline

Update data container based on temperature T and an extra parameter.

Only used in conjunction with MultiRateBase::evalSingle / ReactionRate::eval. This method allows for testing of a reaction rate expression outside of Kinetics reaction rate evaluators.

Definition at line 48 of file ReactionData.h.

◆ update() [4/5]

virtual void update
inline

Update data container based on temperature T and a vector parameter extra

Only used in conjunction with MultiRateBase::evalSingle / ReactionRate::eval. This method allows for testing of a reaction rate expression outside of Kinetics reaction rate evaluators.

Warning
This method is an experimental part of the Cantera API and may be changed or removed without notice.

Definition at line 62 of file ReactionData.h.

◆ update() [5/5]

virtual bool update

Update data container based on thermodynamic phase state.

This update mechanism is used by Kinetics reaction rate evaluators.

Returns
A boolean element indicating whether the evalFromStruct method needs to be called (assuming previously-calculated values were cached)

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