Cantera  2.5.1
Public Member Functions | Public Attributes | List of all members
ThreeBodyReaction Class Reference

A reaction with a non-reacting third body "M" that acts to add or remove energy from the reacting species. More...

#include <Reaction.h>

Inheritance diagram for ThreeBodyReaction:
[legend]
Collaboration diagram for ThreeBodyReaction:
[legend]

Public Member Functions

 ThreeBodyReaction (const Composition &reactants, const Composition &products, const Arrhenius &rate, const ThirdBody &tbody)
 
virtual std::string reactantString () const
 The reactant side of the chemical equation for this reaction. More...
 
virtual std::string productString () const
 The product side of the chemical equation for this reaction. More...
 
- Public Member Functions inherited from ElementaryReaction
 ElementaryReaction (const Composition &reactants, const Composition products, const Arrhenius &rate)
 
virtual void validate ()
 Ensure that the rate constant and other parameters for this reaction are valid. More...
 
- Public Member Functions inherited from Reaction
 Reaction (int type)
 
 Reaction (int type, const Composition &reactants, const Composition &products)
 
std::string equation () const
 The chemical equation for this reaction. More...
 

Public Attributes

ThirdBody third_body
 Relative efficiencies of third-body species in enhancing the reaction rate. More...
 
- Public Attributes inherited from ElementaryReaction
Arrhenius rate
 
bool allow_negative_pre_exponential_factor
 
- Public Attributes inherited from Reaction
int reaction_type
 Type of the reaction. More...
 
Composition reactants
 Reactant species and stoichiometric coefficients. More...
 
Composition products
 Product species and stoichiometric coefficients. More...
 
Composition orders
 Forward reaction order with respect to specific species. More...
 
std::string id
 An identification string for the reaction, used in some filtering operations. More...
 
bool reversible
 True if the current reaction is reversible. False otherwise. More...
 
bool duplicate
 True if the current reaction is marked as duplicate. More...
 
bool allow_nonreactant_orders
 True if reaction orders can be specified for non-reactant species. More...
 
bool allow_negative_orders
 True if negative reaction orders are allowed. Default is false. More...
 
AnyMap input
 Input data used for specific models. More...
 

Detailed Description

A reaction with a non-reacting third body "M" that acts to add or remove energy from the reacting species.

Definition at line 116 of file Reaction.h.

Member Function Documentation

◆ reactantString()

std::string reactantString ( ) const
virtual

The reactant side of the chemical equation for this reaction.

Reimplemented from Reaction.

Definition at line 151 of file Reaction.cpp.

References Reaction::reactantString().

◆ productString()

std::string productString ( ) const
virtual

The product side of the chemical equation for this reaction.

Reimplemented from Reaction.

Definition at line 155 of file Reaction.cpp.

References Reaction::productString().

Member Data Documentation

◆ third_body

ThirdBody third_body

Relative efficiencies of third-body species in enhancing the reaction rate.

Definition at line 127 of file Reaction.h.


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