Cantera
Loading...
Searching...
No Matches
VibrationalRelaxationData Struct Reference

Shared temperature data for vibrational relaxation rates. More...

#include <VibrationalRelaxationRate.h>

Inheritance diagram for VibrationalRelaxationData:
[legend]

Detailed Description

Shared temperature data for vibrational relaxation rates.

Definition at line 22 of file VibrationalRelaxationRate.h.

Public Member Functions

void update (double T) override
 Update cached temperature-dependent data directly from temperature.
bool update (const ThermoPhase &phase, const Kinetics &kin) override
 Update cached temperature-dependent data.
virtual void update (double T, double extra)
 Update data container based on temperature T and an extra parameter.
virtual void update (double T, span< const double > extra)
 Update data container based on temperature T and a vector parameter extra.
Public Member Functions inherited from ReactionData
void perturbTemperature (double deltaT)
 Perturb temperature of data container.
virtual void restore ()
 Restore data container after a perturbation.
virtual void resize (Kinetics &kin)
 Update array sizes that depend on number of species, reactions and phases.
virtual void invalidateCache ()
 Force shared data and reaction rates to be updated next time.

Public Attributes

double recipT13 = 1.0
 \(T^(-1/3)\)
Public Attributes inherited from ReactionData
double temperature = 1.0
 temperature
double logT = 0.0
 logarithm of temperature
double recipT = 1.0
 inverse of temperature

Additional Inherited Members

Protected Attributes inherited from ReactionData
double m_temperature_buf = -1.0
 buffered temperature

Member Function Documentation

◆ update() [1/4]

void update ( double T)
overridevirtual

Update cached temperature-dependent data directly from temperature.

Reimplemented from ReactionData.

Definition at line 20 of file VibrationalRelaxationRate.cpp.

◆ update() [2/4]

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

Update cached temperature-dependent data.

Parameters
phaseThermodynamic phase used to retrieve the gas temperature.
kinKinetics object. Not used here, but required by the ReactionData interface.
Returns
true if the temperature has changed and rates need to be recomputed; false otherwise.

Implements ReactionData.

Definition at line 26 of file VibrationalRelaxationRate.cpp.

◆ update() [3/4]

virtual void update ( double T,
double extra )
inlinevirtual

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.

Reimplemented from ReactionData.

Definition at line 50 of file ReactionData.h.

◆ update() [4/4]

virtual void update ( double T,
span< const double > extra )
inlinevirtual

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.

Reimplemented from ReactionData.

Definition at line 64 of file ReactionData.h.

Member Data Documentation

◆ recipT13

double recipT13 = 1.0

\(T^(-1/3)\)

Definition at line 39 of file VibrationalRelaxationRate.h.


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