Cantera  3.1.0a1
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
C1 Class Reference
Chemical Kinetics » Rate Evaluators » Stoichiometry

Handles one species in a reaction. More...

#include <StoichManager.h>

Detailed Description

Handles one species in a reaction.

See Stoichiometry

Definition at line 131 of file StoichManager.h.

Public Member Functions

 C1 (size_t rxn=0, size_t ic0=0)
 
void incrementSpecies (const double *R, double *S) const
 
void decrementSpecies (const double *R, double *S) const
 
void multiply (const double *S, double *R) const
 
void incrementReaction (const double *S, double *R) const
 
void decrementReaction (const double *S, double *R) const
 
void resizeCoeffs (const map< pair< size_t, size_t >, size_t > &indices)
 
void derivatives (const double *S, const double *R, vector< double > &jac) const
 
void scale (const double *R, double *out, double factor) const
 

Private Attributes

size_t m_rxn
 Reaction number.
 
size_t m_ic0
 Species number.
 
size_t m_jc0
 Index in derivative triplet vector.
 

Constructor & Destructor Documentation

◆ C1()

C1 ( size_t  rxn = 0,
size_t  ic0 = 0 
)
inline

Definition at line 134 of file StoichManager.h.

Member Function Documentation

◆ incrementSpecies()

void incrementSpecies ( const double *  R,
double *  S 
) const
inline

Definition at line 139 of file StoichManager.h.

◆ decrementSpecies()

void decrementSpecies ( const double *  R,
double *  S 
) const
inline

Definition at line 143 of file StoichManager.h.

◆ multiply()

void multiply ( const double *  S,
double *  R 
) const
inline

Definition at line 147 of file StoichManager.h.

◆ incrementReaction()

void incrementReaction ( const double *  S,
double *  R 
) const
inline

Definition at line 151 of file StoichManager.h.

◆ decrementReaction()

void decrementReaction ( const double *  S,
double *  R 
) const
inline

Definition at line 155 of file StoichManager.h.

◆ resizeCoeffs()

void resizeCoeffs ( const map< pair< size_t, size_t >, size_t > &  indices)
inline

Definition at line 159 of file StoichManager.h.

◆ derivatives()

void derivatives ( const double *  S,
const double *  R,
vector< double > &  jac 
) const
inline

Definition at line 164 of file StoichManager.h.

◆ scale()

void scale ( const double *  R,
double *  out,
double  factor 
) const
inline

Definition at line 170 of file StoichManager.h.

Member Data Documentation

◆ m_rxn

size_t m_rxn
private

Reaction number.

Definition at line 177 of file StoichManager.h.

◆ m_ic0

size_t m_ic0
private

Species number.

Definition at line 179 of file StoichManager.h.

◆ m_jc0

size_t m_jc0
private

Index in derivative triplet vector.

Definition at line 181 of file StoichManager.h.

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