diff --git a/include/cantera/kinetics/Kinetics.h b/include/cantera/kinetics/Kinetics.h index e98c176eb..2b94f2345 100644 --- a/include/cantera/kinetics/Kinetics.h +++ b/include/cantera/kinetics/Kinetics.h @@ -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. */ diff --git a/interfaces/cython/cantera/kinetics.pyx b/interfaces/cython/cantera/kinetics.pyx index c587d45ac..d457d0ec3 100644 --- a/interfaces/cython/cantera/kinetics.pyx +++ b/interfaces/cython/cantera/kinetics.pyx @@ -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) diff --git a/interfaces/matlab/toolbox/@Kinetics/fwdRateConstants.m b/interfaces/matlab/toolbox/@Kinetics/fwdRateConstants.m index f548d0162..82f215558 100644 --- a/interfaces/matlab/toolbox/@Kinetics/fwdRateConstants.m +++ b/interfaces/matlab/toolbox/@Kinetics/fwdRateConstants.m @@ -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: diff --git a/interfaces/matlab/toolbox/@Kinetics/revRateConstants.m b/interfaces/matlab/toolbox/@Kinetics/revRateConstants.m index 5a1c5f5df..67c13b605 100644 --- a/interfaces/matlab/toolbox/@Kinetics/revRateConstants.m +++ b/interfaces/matlab/toolbox/@Kinetics/revRateConstants.m @@ -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: