Deprecate ResidEval and ResidJacEval

Cantera · Jun 15, 2023 · 10a3913 · 10a3913
1 parent 71e52c2
commit 10a3913
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 2 deletions.
diff --git a/include/cantera/numerics/ResidEval.h b/include/cantera/numerics/ResidEval.h
@@ -11,6 +11,11 @@
 #include "cantera/base/utilities.h"
 #include "cantera/base/global.h"
 
+#ifndef CT_SKIP_DEPRECATION_WARNINGS
+#pragma message("warning: ResidEval.h and class ResidEval are deprecated and will " \
+                "be removed after Cantera 3.0.")
+#endif
+
 namespace Cantera
 {
 
@@ -27,12 +32,15 @@ const int c_LT_ZERO = -2;
  *             \vec{F}(t,\vec{y}, \vec{y^\prime})
  * \f]
  * The DAE solver attempts to find a solution y(t) such that F = 0.
+ * @deprecated Unused. To be removed after Cantera 3.0.
  *  @ingroup DAE_Group
  */
 class ResidEval
 {
 public:
-    ResidEval() {}
+    ResidEval() {
+        warn_deprecated("class ResidEval", "To be removed after Cantera 3.0");
+    }
     virtual ~ResidEval() {}
 
     /**

diff --git a/include/cantera/numerics/ResidJacEval.h b/include/cantera/numerics/ResidJacEval.h
@@ -13,6 +13,11 @@
 #include "ResidEval.h"
 #include "DenseMatrix.h"
 
+#ifndef CT_SKIP_DEPRECATION_WARNINGS
+#pragma message("warning: ResidJacEval.h and class ResidJacEval are deprecated and " \
+                "will be removed after Cantera 3.0.")
+#endif
+
 namespace Cantera
 {
 
@@ -51,6 +56,8 @@ enum ResidEval_Type_Enum {
  * A class for full (non-sparse dense matrices with Fortran-compatible data
  * storage. The class adds support for identifying what types of calls are made
  * to the residual evaluator by adding the ResidEval_Type_Enum class.
+ *
+ * @deprecated Unused. To be removed after Cantera 3.0.
  */
 class ResidJacEval : public ResidEval
 {

diff --git a/include/cantera/thermo/MixtureFugacityTP.h b/include/cantera/thermo/MixtureFugacityTP.h
@@ -12,7 +12,6 @@
 #define CT_MIXTUREFUGACITYTP_H
 
 #include "ThermoPhase.h"
-#include "cantera/numerics/ResidEval.h"
 
 namespace Cantera
 {

diff --git a/src/numerics/ResidJacEval.cpp b/src/numerics/ResidJacEval.cpp
@@ -11,6 +11,7 @@ namespace Cantera
 ResidJacEval::ResidJacEval(doublereal atol) :
     m_atol(atol)
 {
+    warn_deprecated("class ResidJacEval", "To be removed after Cantera 3.0");
 }
 
 int ResidJacEval::nEquations() const

diff --git a/src/thermo/MixtureFugacityTP.cpp b/src/thermo/MixtureFugacityTP.cpp
@@ -10,6 +10,8 @@
 
 #include "cantera/thermo/MixtureFugacityTP.h"
 #include "cantera/base/stringUtils.h"
+#include "cantera/base/utilities.h"
+#include "cantera/base/global.h"
 
 using namespace std;
 

diff --git a/src/thermo/PengRobinson.cpp b/src/thermo/PengRobinson.cpp
@@ -7,6 +7,7 @@
 #include "cantera/thermo/ThermoFactory.h"
 #include "cantera/thermo/Species.h"
 #include "cantera/base/stringUtils.h"
+#include "cantera/base/utilities.h"
 
 #include <boost/algorithm/string.hpp>
 #include <boost/math/tools/roots.hpp>

diff --git a/src/thermo/RedlichKwongMFTP.cpp b/src/thermo/RedlichKwongMFTP.cpp
@@ -7,6 +7,7 @@
 #include "cantera/thermo/ThermoFactory.h"
 #include "cantera/thermo/Species.h"
 #include "cantera/base/stringUtils.h"
+#include "cantera/base/utilities.h"
 
 #include <boost/algorithm/string.hpp>
 #include <boost/math/tools/roots.hpp>