[Kinetics] Deprecate obsolete reaction rate classes/methods

Cantera · Mar 20, 2022 · 4447ca9 · 4447ca9
1 parent 710d68b
commit 4447ca9
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/include/cantera/kinetics/ChebyshevRate.h b/include/cantera/kinetics/ChebyshevRate.h
@@ -167,6 +167,8 @@ class ChebyshevRate final : public ReactionRate
 
     //! Update concentration-dependent parts of the rate coefficient.
     //! @param c base-10 logarithm of the pressure in Pa
+    //! @deprecated To be removed after Cantera 2.6. Implementation will be moved to
+    //! the updateFromStruct() method.
     void update_C(const double* c) {
         m_log10P = c[0];
         double Pr = (2 * c[0] + PrNum_) * PrDen_;
@@ -190,6 +192,8 @@ class ChebyshevRate final : public ReactionRate
      * Update the value the rate constant.
      *
      * This function returns the actual value of the rate constant.
+     * @deprecated To be removed after Cantera 2.6. Implementation will be moved to
+     * the evalFromStruct() method.
      */
     double updateRC(double logT, double recipT) const {
         double Tr = (2 * recipT + TrNum_) * TrDen_;

diff --git a/include/cantera/kinetics/PlogRate.h b/include/cantera/kinetics/PlogRate.h
@@ -147,6 +147,8 @@ class PlogRate final : public ReactionRate
 
     //! Update concentration-dependent parts of the rate coefficient.
     //! @param c natural log of the pressure in Pa
+    //! @deprecated To be removed after Cantera 2.6. Implementation will be moved to
+    //! the updateFromStruct() method.
     void update_C(const double* c) {
         logP_ = c[0];
         if (logP_ > logP1_ && logP_ < logP2_) {
@@ -176,6 +178,8 @@ class PlogRate final : public ReactionRate
      * Update the value the rate constant.
      *
      * This function returns the actual value of the rate constant.
+     * @deprecated To be removed after Cantera 2.6. Implementation will be moved to
+     * the evalFromStruct() method.
      */
     double updateRC(double logT, double recipT) const {
         double log_k1, log_k2;

diff --git a/include/cantera/kinetics/RxnRates.h b/include/cantera/kinetics/RxnRates.h
@@ -1,8 +1,7 @@
 /**
  *  @file RxnRates.h
- *
- * @todo  at least part of the content of this file should be transferred
- *     to ReactionRate.h once the old XML interface is removed after Cantera 2.6
+ *  @deprecated To be removed after Cantera 2.6. See class Cantera::ReactionRate and
+ *      derived classes for new reaction rate handlers.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or
@@ -36,6 +35,8 @@ class Func1;
  *   \f[
  *        k_f =  A T^b \exp (-E/RT)
  *   \f]
+ *
+ * @deprecated To be removed after Cantera 2.6. See Arrhenius3 / ArrheniusRate.
  */
 class Arrhenius2 final : public Arrhenius3
 {
@@ -127,6 +128,8 @@ class Arrhenius2 final : public Arrhenius3
  *   \f]
  * where the parameters \f$ (a_k, E_k, m_k) \f$ describe the dependency on the
  * surface coverage of species \f$k, \theta_k \f$.
+ *
+ * @deprecated To be removed after Cantera 2.6. See InterfaceRate and StickingRate.
  */
 class SurfaceArrhenius
 {