Skip to content

Commit ac14f3d

Browse files
committed
[Kinetics] Deprecate obsolete reaction rate classes/methods
1 parent 7529467 commit ac14f3d

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

include/cantera/kinetics/ChebyshevRate.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,8 @@ class ChebyshevRate final : public ReactionRate
167167

168168
//! Update concentration-dependent parts of the rate coefficient.
169169
//! @param c base-10 logarithm of the pressure in Pa
170+
//! @deprecated To be removed after Cantera 2.6. Implementation will be moved to
171+
//! the updateFromStruct() method.
170172
void update_C(const double* c) {
171173
m_log10P = c[0];
172174
double Pr = (2 * c[0] + PrNum_) * PrDen_;
@@ -190,6 +192,8 @@ class ChebyshevRate final : public ReactionRate
190192
* Update the value the rate constant.
191193
*
192194
* This function returns the actual value of the rate constant.
195+
* @deprecated To be removed after Cantera 2.6. Implementation will be moved to
196+
* the evalFromStruct() method.
193197
*/
194198
double updateRC(double logT, double recipT) const {
195199
double Tr = (2 * recipT + TrNum_) * TrDen_;

include/cantera/kinetics/PlogRate.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ class PlogRate final : public ReactionRate
147147

148148
//! Update concentration-dependent parts of the rate coefficient.
149149
//! @param c natural log of the pressure in Pa
150+
//! @deprecated To be removed after Cantera 2.6. Implementation will be moved to
151+
//! the updateFromStruct() method.
150152
void update_C(const double* c) {
151153
logP_ = c[0];
152154
if (logP_ > logP1_ && logP_ < logP2_) {
@@ -176,6 +178,8 @@ class PlogRate final : public ReactionRate
176178
* Update the value the rate constant.
177179
*
178180
* This function returns the actual value of the rate constant.
181+
* @deprecated To be removed after Cantera 2.6. Implementation will be moved to
182+
* the evalFromStruct() method.
179183
*/
180184
double updateRC(double logT, double recipT) const {
181185
double log_k1, log_k2;

include/cantera/kinetics/RxnRates.h

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
/**
22
* @file RxnRates.h
3-
*
4-
* @todo at least part of the content of this file should be transferred
5-
* to ReactionRate.h once the old XML interface is removed after Cantera 2.6
3+
* @deprecated To be removed after Cantera 2.6. See class Cantera::ReactionRate and
4+
* derived classes for new reaction rate handlers.
65
*/
76

87
// This file is part of Cantera. See License.txt in the top-level directory or
@@ -36,6 +35,8 @@ class Func1;
3635
* \f[
3736
* k_f = A T^b \exp (-E/RT)
3837
* \f]
38+
*
39+
* @deprecated To be removed after Cantera 2.6. See Arrhenius3 / ArrheniusRate.
3940
*/
4041
class Arrhenius2 final : public Arrhenius3
4142
{
@@ -127,6 +128,8 @@ class Arrhenius2 final : public Arrhenius3
127128
* \f]
128129
* where the parameters \f$ (a_k, E_k, m_k) \f$ describe the dependency on the
129130
* surface coverage of species \f$k, \theta_k \f$.
131+
*
132+
* @deprecated To be removed after Cantera 2.6. See InterfaceRate and StickingRate.
130133
*/
131134
class SurfaceArrhenius
132135
{

0 commit comments

Comments
 (0)