The SRI falloff function. More...

#include <Falloff.h>

Inheritance diagram for SriRate:

Collaboration diagram for SriRate:

Public Member Functions
	SriRate ()
	Constructor. More...

	SriRate (const AnyMap &node, const UnitStack &rate_units={})

	SriRate (const ArrheniusRate &low, const ArrheniusRate &high, const vector_fp &c)

unique_ptr< MultiRateBase >	newMultiRate () const
	Create a rate evaluator for reactions of a particular derived type. More...

virtual void	setFalloffCoeffs (const vector_fp &c)
	Set coefficients used by parameterization. More...

virtual void	getFalloffCoeffs (vector_fp &c) const
	Retrieve coefficients of the falloff parameterization. More...

virtual void	updateTemp (double T, double *work) const
	Update the temperature parameters in the representation. More...

virtual double	F (double pr, const double *work) const
	The falloff function. More...

virtual size_t	workSize () const
	The size of the work array required. More...

virtual const std::string	type () const
	String identifying reaction rate specialization. More...

virtual size_t	nParameters () const
	Returns the number of parameters used by this parameterization. More...

virtual void	setParameters (const AnyMap &node, const UnitStack &rate_units)
	Set parameters. More...

virtual void	getParameters (double *params) const
	Sets params to contain, in order,. More...

virtual void	getParameters (AnyMap &node) const
	Get parameters. More...

Public Member Functions inherited from FalloffRate
	FalloffRate (const AnyMap &node, const UnitStack &rate_units={})

void	init (const vector_fp &c)
	Initialize. More...

double	evalF (double T, double conc3b)
	Evaluate falloff function at current conditions. More...

virtual double	evalFromStruct (const FalloffData &shared_data)
	Evaluate reaction rate. More...

void	check (const std::string &equation, const AnyMap &node)
	Check basic syntax and settings of reaction rate expression. More...

virtual void	validate (const std::string &equation, const Kinetics &kin)
	Validate the reaction rate expression. More...

bool	allowNegativePreExponentialFactor () const
	Get flag indicating whether negative A values are permitted. More...

void	setAllowNegativePreExponentialFactor (bool value)
	Set flag indicating whether negative A values are permitted. More...

bool	chemicallyActivated () const
	Get flag indicating whether reaction is chemically activated. More...

void	setChemicallyActivated (bool activated)
	Set flag indicating whether reaction is chemically activated. More...

ArrheniusRate &	lowRate ()
	Get reaction rate in the low-pressure limit. More...

void	setLowRate (const ArrheniusRate &low)
	Set reaction rate in the low-pressure limit. More...

ArrheniusRate &	highRate ()
	Get reaction rate in the high-pressure limit. More...

void	setHighRate (const ArrheniusRate &high)
	Set reaction rate in the high-pressure limit. More...

Public Member Functions inherited from ReactionRate
	ReactionRate (const ReactionRate &other)

ReactionRate &	operator= (const ReactionRate &other)

AnyMap	parameters () const
	Return the parameters such that an identical Reaction could be reconstructed using the newReaction() function. More...

virtual void	validate (const std::string &equation)
	Validate the reaction rate expression (legacy call) More...

size_t	rateIndex () const
	Reaction rate index within kinetics evaluator. More...

void	setRateIndex (size_t idx)
	Set reaction rate index within kinetics evaluator. More...

virtual void	setContext (const Reaction &rxn, const Kinetics &kin)
	Set context of reaction rate evaluation. More...

double	eval (double T)
	Evaluate reaction rate based on temperature. More...

double	eval (double T, double extra)
	Evaluate reaction rate based on temperature and an extra parameter. More...

double	eval (double T, const std::vector< double > &extra)
	Evaluate reaction rate based on temperature and an extra vector parameter. More...

Protected Attributes
double	m_a
	parameter a in the 5-parameter SRI falloff function. Dimensionless. More...

double	m_b
	parameter b in the 5-parameter SRI falloff function. [K] More...

double	m_c
	parameter c in the 5-parameter SRI falloff function. [K] More...

double	m_d
	parameter d in the 5-parameter SRI falloff function. Dimensionless. More...

double	m_e
	parameter d in the 5-parameter SRI falloff function. Dimensionless. More...

Protected Attributes inherited from FalloffRate
ArrheniusRate	m_lowRate
	The reaction rate in the low-pressure limit. More...

ArrheniusRate	m_highRate
	The reaction rate in the high-pressure limit. More...

bool	m_chemicallyActivated
	Flag labeling reaction as chemically activated. More...

bool	m_negativeA_ok
	Flag indicating whether negative A values are permitted. More...

double	m_rc_low
	Evaluated reaction rate in the low-pressure limit. More...

double	m_rc_high
	Evaluated reaction rate in the high-pressure limit. More...

vector_fp	m_work
	Work vector. More...

Protected Attributes inherited from ReactionRate
AnyMap	m_input
	Input data used for specific models. More...

size_t	m_rate_index
	Index of reaction rate within kinetics evaluator. More...

Additional Inherited Members

Detailed Description

The SRI falloff function.

The falloff function defines the value of \( F \) in the following rate expression

\[ k = k_{\infty} \left( \frac{P_r}{1 + P_r} \right) F \]

where

\[ P_r = \frac{k_0 [M]}{k_{\infty}} \]

\[ F = {\left( a \; exp(\frac{-b}{T}) + exp(\frac{-T}{c})\right)}^n \; d \; T^e \]

where

\[ n = \frac{1.0}{1.0 + (\log_{10} P_r)^2} \]

\( c \) s required to greater than or equal to zero. If it is zero, then the corresponding term is set to zero.

\( d \) is required to be greater than zero.

Definition at line 436 of file Falloff.h.

Constructor & Destructor Documentation

◆ SriRate() [1/3]

SriRate ( )

inline

Constructor.

Definition at line 440 of file Falloff.h.

References FalloffRate::m_work.

◆ SriRate() [2/3]

SriRate	(	const AnyMap &	node,
		const UnitStack &	rate_units = `{}`
	)

inline

Definition at line 444 of file Falloff.h.

◆ SriRate() [3/3]

SriRate	(	const ArrheniusRate &	low,
		const ArrheniusRate &	high,
		const vector_fp &	c
	)

inline

Definition at line 450 of file Falloff.h.

Member Function Documentation

◆ newMultiRate()

unique_ptr< MultiRateBase > newMultiRate ( ) const

inlinevirtual

Create a rate evaluator for reactions of a particular derived type.

Derived classes usually implement this as:

unique_ptr<MultiRateBase> newMultiRate() const override {

return unique_ptr<MultiRateBase>(new MultiRate<RateType, DataType>);

Cantera::SriRate::newMultiRate

unique_ptr< MultiRateBase > newMultiRate() const

Create a rate evaluator for reactions of a particular derived type.

Definition: Falloff.h:458

where RateType is the derived class name and DataType is the corresponding container for parameters needed to evaluate reactions of that type.

Reimplemented from ReactionRate.

Definition at line 458 of file Falloff.h.

◆ setFalloffCoeffs()

void setFalloffCoeffs ( const vector_fp & c )

virtual

Set coefficients used by parameterization.

Parameters

c	Vector of three or five doubles: The doubles are the parameters, a, b, c, d (optional; default 1.0), and e (optional; default 0.0) of the SRI parameterization

Reimplemented from FalloffRate.

Definition at line 328 of file Falloff.cpp.

◆ getFalloffCoeffs()

void getFalloffCoeffs ( vector_fp & c ) const

virtual

Retrieve coefficients of the falloff parameterization.

Parameters

c	Vector of coefficients of the parameterization. The number and meaning of these coefficients is subclass-dependent.

Reimplemented from FalloffRate.

Definition at line 357 of file Falloff.cpp.

References Cantera::SmallNumber.

◆ updateTemp()

void updateTemp	(	double	T,
		double *	work
	)		const

virtual

Update the temperature parameters in the representation.

Parameters

T	Temperature (Kelvin)
work	Vector of working space, length 2, representing the temperature-dependent part of the parameterization.

Reimplemented from FalloffRate.

Definition at line 366 of file Falloff.cpp.

◆ F()

double F	(	double	pr,
		const double *	work
	)		const

virtual

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

pr	reduced pressure (dimensionless).
work	array of size workSize() containing cached temperature-dependent intermediate results from a prior call to updateTemp.

Returns: the value of the falloff function \( F \) defined above

Reimplemented from FalloffRate.

Definition at line 375 of file Falloff.cpp.

◆ workSize()

virtual size_t workSize ( ) const

inlinevirtual

The size of the work array required.

Todo:: deprecate; only used by legacy framework

Reimplemented from FalloffRate.

Definition at line 482 of file Falloff.h.

◆ type()

virtual const std::string type ( ) const

inlinevirtual

String identifying reaction rate specialization.

Reimplemented from FalloffRate.

Definition at line 486 of file Falloff.h.

◆ nParameters()

virtual size_t nParameters ( ) const

inlinevirtual

Returns the number of parameters used by this parameterization.

The values of these parameters can be obtained from getParameters().

Reimplemented from FalloffRate.

Definition at line 490 of file Falloff.h.

◆ setParameters()

void setParameters	(	const AnyMap &	node,
		const UnitStack &	units
	)

virtual

Set parameters.

Parameters

node	AnyMap object containing reaction rate specification
units	unit definitions specific to rate information

Reimplemented from FalloffRate.

Definition at line 382 of file Falloff.cpp.

References AnyMap::empty().

◆ getParameters() [1/2]

void getParameters ( double * params ) const

virtual

Sets params to contain, in order,.

\[ (a, b, c, d, e) \]

Todo:: deprecate; superseded by getFalloffCoeffs

Reimplemented from FalloffRate.

Definition at line 407 of file Falloff.cpp.

◆ getParameters() [2/2]

void getParameters ( AnyMap & node ) const

virtual

Get parameters.

Parameters

node	AnyMap containing rate information Store the parameters of a ReactionRate needed to reconstruct an identical object. Does not include user-defined fields available in the m_input map.

Reimplemented from FalloffRate.

Definition at line 416 of file Falloff.cpp.

References AnyMap::setFlowStyle().

Member Data Documentation

◆ m_a

double m_a

protected

parameter a in the 5-parameter SRI falloff function. Dimensionless.

Definition at line 506 of file Falloff.h.

◆ m_b

double m_b

protected

parameter b in the 5-parameter SRI falloff function. [K]

Definition at line 509 of file Falloff.h.

◆ m_c

double m_c

protected

parameter c in the 5-parameter SRI falloff function. [K]

Definition at line 512 of file Falloff.h.

◆ m_d

double m_d

protected

parameter d in the 5-parameter SRI falloff function. Dimensionless.

Definition at line 515 of file Falloff.h.

◆ m_e

double m_e

protected

parameter d in the 5-parameter SRI falloff function. Dimensionless.

Definition at line 518 of file Falloff.h.

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SriRate() [1/3]

◆ SriRate() [2/3]

◆ SriRate() [3/3]

Member Function Documentation

◆ newMultiRate()

◆ setFalloffCoeffs()

◆ getFalloffCoeffs()

◆ updateTemp()

◆ F()

◆ workSize()

◆ type()

◆ nParameters()

◆ setParameters()

◆ getParameters() [1/2]

◆ getParameters() [2/2]

Member Data Documentation

◆ m_a

◆ m_b

◆ m_c

◆ m_d

◆ m_e