research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doxygen update

Browse source 
Added docs.
  Took out ingroup kinetics -> doesn't seem to be a module named kinetics
   any more.
This commit is contained in:
Harry Moffat 2007-06-12 14:13:11 +00:00
parent ecb4307600
commit 67947032e6
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Cantera/src/kinetics/Kinetics.h
View file

@ -118,8 +118,13 @@ namespace Cantera {
* non-virtual methods perform generic functions and are
* implemented in Kinetics. They should not be overloaded. Only
* those methods required by a subclass need to be overloaded;
* the rest will throw exceptions if called. @ingroup kinetics
* @ingroup kineticsmgr
* the rest will throw exceptions if called.
*
* When the nomenclature "kinetics species index" is used below,
* this means that the species index ranges over all species in
* all phases handled by the kinetics manager.
*
* @ingroup kineticsmgr
*/
class Kinetics {
@ -587,7 +592,7 @@ namespace Cantera {
* Stoichiometric coefficient of species k as a reactant in
* reaction i.
*
* @param k species index
* @param k kinetic species index
* @param i reaction index
*/
virtual doublereal reactantStoichCoeff(int k, int i) const {
@ -599,7 +604,7 @@ namespace Cantera {
* Stoichiometric coefficient of species k as a product in
* reaction i.
*
* @param k species index
* @param k kinetic species index
* @param i reaction index
*/
virtual doublereal productStoichCoeff(int k, int i) const {
@ -610,7 +615,7 @@ namespace Cantera {
/**
* reactant Order of species k in reaction i.
*
* @param k species index
* @param k kinetic species index
* @param i reaction index
*/
virtual doublereal reactantOrder(int k, int i) const {