A class for managing third-body efficiencies, including default values. More...

#include <Reaction.h>

Detailed Description

A class for managing third-body efficiencies, including default values.

Definition at line 191 of file Reaction.h.

Public Member Functions
	ThirdBody (const string &third_body)

	ThirdBody (const AnyMap &node)

string	name () const
	Name of the third body collider. More...

void	setName (const string &third_body)
	Set name of the third body collider. More...

void	setParameters (const AnyMap &node)
	Set third-body efficiencies from AnyMap node More...

void	getParameters (AnyMap &node) const
	Get third-body efficiencies from AnyMap node More...

double	efficiency (const string &k) const
	Get the third-body efficiency for species k More...

string	collider () const
	Suffix representing the third body collider in reaction equation, for example `+ M` or `(+M)` More...

bool	checkSpecies (const Reaction &rxn, const Kinetics &kin) const
	Verify that all species involved in collision efficiencies are defined in the Kinetics object. More...

Public Attributes
Composition	efficiencies
	Map of species to third body efficiency. More...

double	default_efficiency = 1.
	The default third body efficiency for species not listed in efficiencies. More...

bool	mass_action = true
	Third body is used by law of mass action (`true` for three-body reactions, `false` for falloff reactions) More...

bool	explicit_3rd = false
	Flag indicating whether third body requires explicit serialization. More...

Protected Attributes
string	m_name = "M"
	Name of the third body collider. More...

Member Function Documentation

◆ name()

string name ( ) const

inline

Name of the third body collider.

Since: New in Cantera 3.0

Definition at line 200 of file Reaction.h.

◆ setName()

void setName ( const string & third_body )

Set name of the third body collider.

Since: New in Cantera 3.0

Definition at line 724 of file Reaction.cpp.

◆ setParameters()

void setParameters ( const AnyMap & node )

Set third-body efficiencies from AnyMap node

Since: New in Cantera 3.0

Definition at line 757 of file Reaction.cpp.

◆ getParameters()

void getParameters ( AnyMap & node ) const

Get third-body efficiencies from AnyMap node

Parameters

node	AnyMap receiving serialized parameters

Since: New in Cantera 3.0

Definition at line 779 of file Reaction.cpp.

◆ efficiency()

double efficiency ( const string & k ) const

Get the third-body efficiency for species k

Definition at line 792 of file Reaction.cpp.

◆ collider()

string collider ( ) const

Suffix representing the third body collider in reaction equation, for example + M or (+M)

Since: New in Cantera 3.0

Definition at line 797 of file Reaction.cpp.

◆ checkSpecies()

bool checkSpecies	(	const Reaction &	rxn,
		const Kinetics &	kin
	)		const

Verify that all species involved in collision efficiencies are defined in the Kinetics object.

The function returns true if all species are found, and raises an exception unless the Kinetics object is configured to skip undeclared species, in which case false is returned.

Parameters

rxn	Reaction object
kin	Kinetics object

Since: New in Cantera 3.0

Definition at line 805 of file Reaction.cpp.

Member Data Documentation

◆ efficiencies

Composition efficiencies

Map of species to third body efficiency.

Definition at line 235 of file Reaction.h.

◆ default_efficiency

double default_efficiency = 1.

The default third body efficiency for species not listed in efficiencies.

Definition at line 238 of file Reaction.h.

◆ mass_action

bool mass_action = true

Third body is used by law of mass action (true for three-body reactions, false for falloff reactions)

Definition at line 242 of file Reaction.h.

◆ explicit_3rd

bool explicit_3rd = false

Flag indicating whether third body requires explicit serialization.

Definition at line 245 of file Reaction.h.

◆ m_name

string m_name = "M"

protected