[Kinetics] deprecate magic number types in RxnRates.h

This commit is contained in:
Ingmar Schoegl 2019-10-24 17:57:37 -05:00 committed by Ray Speth
parent 91c7bf14d7
commit 58063b498a
2 changed files with 24 additions and 0 deletions

View file

@ -11,6 +11,7 @@
#include "cantera/kinetics/reaction_defs.h"
#include "cantera/base/ctexceptions.h"
#include "cantera/base/stringUtils.h"
#include "cantera/base/global.h"
#include <iostream>
@ -31,7 +32,12 @@ class Arrhenius
{
public:
//! return the rate coefficient type.
/*!
* @deprecated To be removed after Cantera 2.5.
*/
static int type() {
warn_deprecated("Arrhenius::type()",
"To be removed after Cantera 2.5.");
return ARRHENIUS_REACTION_RATECOEFF_TYPE;
}
@ -119,7 +125,12 @@ class SurfaceArrhenius
{
public:
/*!
* @deprecated To be removed after Cantera 2.5.
*/
static int type() {
warn_deprecated("SurfaceArrhenius::type()",
"To be removed after Cantera 2.5.");
return SURF_ARRHENIUS_REACTION_RATECOEFF_TYPE;
}
@ -211,7 +222,12 @@ class Plog
{
public:
//! return the rate coefficient type.
/*!
* @deprecated To be removed after Cantera 2.5.
*/
static int type() {
warn_deprecated("Plog::type()",
"To be removed after Cantera 2.5.");
return PLOG_REACTION_RATECOEFF_TYPE;
}
@ -340,7 +356,12 @@ class ChebyshevRate
{
public:
//! return the rate coefficient type.
/*!
* @deprecated To be removed after Cantera 2.5.
*/
static int type() {
warn_deprecated("ChebyshevRate::type()",
"To be removed after Cantera 2.5.");
return CHEBYSHEV_REACTION_RATECOEFF_TYPE;
}

View file

@ -116,6 +116,9 @@ const int GLOBAL_RXN = 30;
*
* Note that not all of these are currently implemented!
* @todo Finish implementing reaction rate types.
*
* Magic numbers
* @deprecated To be removed after Cantera 2.5.
*/
//@{