Cantera  2.3.0
Public Member Functions | Public Attributes | List of all members
ThirdBody Class Reference

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

#include <Reaction.h>

Public Member Functions

 ThirdBody (double default_efficiency=1.0)
 
double efficiency (const std::string &k) const
 Get the third-body efficiency for species k More...
 

Public Attributes

Composition efficiencies
 Map of species to third body efficiency. More...
 
double default_efficiency
 The default third body efficiency for species not listed in efficiencies. More...
 

Detailed Description

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

Definition at line 92 of file Reaction.h.

Member Function Documentation

◆ efficiency()

double efficiency ( const std::string &  k) const
inline

Get the third-body efficiency for species k

Definition at line 98 of file Reaction.h.

References ThirdBody::default_efficiency, ThirdBody::efficiencies, and Cantera::getValue().

Member Data Documentation

◆ efficiencies

Composition efficiencies

Map of species to third body efficiency.

Definition at line 103 of file Reaction.h.

Referenced by ThirdBody::efficiency(), FalloffReaction::productString(), and FalloffReaction::reactantString().

◆ default_efficiency

double default_efficiency

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

Definition at line 107 of file Reaction.h.

Referenced by ThirdBody::efficiency(), FalloffReaction::productString(), and FalloffReaction::reactantString().


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