From 3ff5d87b815eb6c299745954947ff566e55066cc Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 30 Jan 2019 22:09:06 -0500 Subject: [PATCH] [Doc] Fix descriptions and units of coverage dependency parameters --- include/cantera/kinetics/Reaction.h | 8 ++++---- include/cantera/kinetics/RxnRates.h | 7 +++---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/include/cantera/kinetics/Reaction.h b/include/cantera/kinetics/Reaction.h index 227a25222..871cee1e9 100644 --- a/include/cantera/kinetics/Reaction.h +++ b/include/cantera/kinetics/Reaction.h @@ -192,14 +192,14 @@ public: struct CoverageDependency { //! Constructor - //! @param a_ modification to the pre-exponential factor [m, kmol, s units] + //! @param a_ coefficient for exponential dependence on coverage [dimensionless] //! @param E_ modification to the activation energy [K] - //! @param m_ modification to the temperature exponent + //! @param m_ exponent for power law dependence on coverage [dimensionless] CoverageDependency(double a_, double E_, double m_) : a(a_), E(E_), m(m_) {} CoverageDependency() {} - double a; //!< modification to the pre-exponential factor [m, kmol, s units] + double a; //!< coefficient for exponential dependence on coverage [dimensionless] double E; //!< modification to the activation energy [K] - double m; //!< modification to the temperature exponent + double m; //!< exponent for power law dependence on coverage [dimensionless] }; //! A reaction occurring on an interface (i.e. a SurfPhase or an EdgePhase) diff --git a/include/cantera/kinetics/RxnRates.h b/include/cantera/kinetics/RxnRates.h index 7bd91e45e..6e7498140 100644 --- a/include/cantera/kinetics/RxnRates.h +++ b/include/cantera/kinetics/RxnRates.h @@ -126,10 +126,9 @@ public: SurfaceArrhenius(); explicit SurfaceArrhenius(double A, double b, double Ta); - //! Add a coverage dependency for species *k*, with pre-exponential - //! dependence *a*, rate constant exponential dependency *m*, and activation - //! energy dependence *e*, where *e* is in Kelvin, i.e. energy divided by - //! the molar gas constant. + //! Add a coverage dependency for species *k*, with exponential dependence + //! *a*, power-law exponent *m*, and activation energy dependence *e*, + //! where *e* is in Kelvin, i.e. energy divided by the molar gas constant. void addCoverageDependence(size_t k, doublereal a, doublereal m, doublereal e);