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

[Doc/Kinetics] Clarify values returned by getFwdRateConstants

Browse source
This commit is contained in:
Ray Speth 2017-12-20 16:35:16 -05:00
parent ebc478f8ec
commit 831b92dac4
4 changed files with 26 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
include/cantera/kinetics/Kinetics.h
View file

@ -636,7 +636,10 @@ public:
/**
* Return the forward rate constants
*
* length is the number of reactions. units depends on many issues.
* The computed values include all temperature-dependent, pressure-dependent,
* and third body contributions. Length is the number of reactions. Units are
* a combination of kmol, m^3 and s, that depend on the rate expression for
* the reaction.
*
* @param kfwd Output vector containing the forward reaction rate
* constants. Length: nReactions().
@ -648,11 +651,13 @@ public:
/**
* Return the reverse rate constants.
*
* length is the number of reactions. units depends on many issues. Note,
* this routine will return rate constants for irreversible reactions if
* the default for doIrreversible is overridden.
* The computed values include all temperature-dependent, pressure-dependent,
* and third body contributions. Length is the number of reactions. Units are
* a combination of kmol, m^3 and s, that depend on the rate expression for
* the reaction. Note, this routine will return rate constants for
* irreversible reactions if the default for `doIrreversible` is overridden.
*
* @param krev Output vector of reverse rate constants.
* @param krev Output vector of reverse rate constants
* @param doIrreversible boolean indicating whether irreversible reactions
* should be included.
*/

12
interfaces/cython/cantera/kinetics.pyx
View file

@ -258,16 +258,20 @@ cdef class Kinetics(_SolutionBase):
property forward_rate_constants:
"""
Forward rate constants for all reactions. Units are a combination of
kmol, m^3 and s, that depend on the rate expression for the reaction.
Forward rate constants for all reactions. The computed values include
all temperature-dependent, pressure-dependent, and third body
contributions. Units are a combination of kmol, m^3 and s, that depend
on the rate expression for the reaction.
"""
def __get__(self):
return get_reaction_array(self, kin_getFwdRateConstants)
property reverse_rate_constants:
"""
Reverse rate constants for all reactions. Units are a combination of
kmol, m^3 and s, that depend on the rate expression for the reaction.
Reverse rate constants for all reactions. The computed values include
all temperature-dependent, pressure-dependent, and third body
contributions. Units are a combination of kmol, m^3 and s, that depend
on the rate expression for the reaction.
"""
def __get__(self):
return get_reaction_array(self, kin_getRevRateConstants)

4
interfaces/matlab/toolbox/@Kinetics/fwdRateConstants.m
View file

@ -2,6 +2,10 @@ function kf = fwdRateConstants(a)
% FWDRATECONSTANTS Get the forward reaction rate constants.
% kf = fwdRateConstants(a)
%
% The computed values include all temperature-dependent, pressure-dependent, and
% third body contributions. Units are a combination of kmol, m^3 and s, that
% depend on the rate expression for the reaction.
%
% see also: :mat:func:`revRateConstants`, :mat:func:`equil_Kc`
%
% :param a:

4
interfaces/matlab/toolbox/@Kinetics/revRateConstants.m
View file

@ -2,6 +2,10 @@ function kr = revRateConstants(a)
% REVRATECONSTANTS Get the reverse reaction rate constants.
% kr = revRateConstants(a)
%
% The computed values include all temperature-dependent, pressure-dependent, and
% third body contributions. Units are a combination of kmol, m^3 and s, that
% depend on the rate expression for the reaction.
%
% See also: :mat:func:`fwdRateConstants`, :mat:func:`equil_KC`
%
% :param a: