Deprecate FuncEval::getInitialConditions and related functions

include/cantera/kinetics/ImplicitSurfChem.h

@@ -141,6 +141,7 @@ public:
      *  @param y   Value of the solution vector to be used.
      *            On output, this contains the initial value
      *           of the solution.
+     *  @deprecated Use getState() instead. To be removed after Cantera 2.3.
      */
     virtual void getInitialConditions(doublereal t0,
                                       size_t leny, doublereal* y);

include/cantera/numerics/FuncEval.h

@@ -8,6 +8,8 @@
 #define CT_FUNCEVAL_H
 
 #include "cantera/base/ct_defs.h"
+#include "cantera/base/ctexceptions.h"
+#include "cantera/base/global.h"
 
 namespace Cantera
 {
@@ -38,8 +40,18 @@ public:
     /**
      * Fill the solution vector with the initial conditions
      * at initial time t0.
+     * @deprecated Use getState() instead. To be removed after Cantera 2.3.
      */
-    virtual void getInitialConditions(double t0, size_t leny, double* y)=0;
+    virtual void getInitialConditions(double t0, size_t leny, double* y) {
+        warn_deprecated("FuncEval::getInitialConditions",
+            "Use getState instead. To be removed after Cantera 2.3.");
+        getState(y);
+    }
+
+    //! Fill in the vector *y* with the current state of the system
+    virtual void getState(double* y) {
+        throw NotImplementedError("FuncEval::getState");
+    }
 
     //! Number of equations.
     virtual size_t neq()=0;

include/cantera/zeroD/ConstPressureReactor.h

@@ -29,6 +29,7 @@ public:
         return ConstPressureReactorType;
     }
 
+    //! @deprecated Use getState instead. To be removed after Cantera 2.3.
     virtual void getInitialConditions(doublereal t0, size_t leny,
                                       doublereal* y);
     virtual void getState(doublereal* y);

include/cantera/zeroD/FlowReactor.h

@@ -24,6 +24,7 @@ public:
         return FlowReactorType;
     }
 
+    //! @deprecated Use getState instead. To be removed after Cantera 2.3.
     virtual void getInitialConditions(doublereal t0, size_t leny,
                                       doublereal* y);
     virtual void getState(doublereal* y);

include/cantera/zeroD/IdealGasConstPressureReactor.h

@@ -31,6 +31,7 @@ public:
 
     virtual void setThermoMgr(ThermoPhase& thermo);
 
+    //! @deprecated Use getState instead. To be removed after Cantera 2.3.
     virtual void getInitialConditions(doublereal t0, size_t leny,
                                       doublereal* y);
     virtual void getState(doublereal* y);

include/cantera/zeroD/IdealGasReactor.h

@@ -28,6 +28,7 @@ public:
 
     virtual void setThermoMgr(ThermoPhase& thermo);
 
+    //! @deprecated Use getState instead. To be removed after Cantera 2.3.
     virtual void getInitialConditions(doublereal t0, size_t leny,
                                       doublereal* y);
     virtual void getState(doublereal* y);

include/cantera/zeroD/Reactor.h

@@ -100,6 +100,7 @@ public:
      *  @param[in] t0 Time at which initial conditions are determined
      *  @param[in] leny Length of *y* (unused)
      *  @param[out] y state vector representing the initial state of the reactor
+     *  @deprecated Use getState instead. To be removed after Cantera 2.3.
      */
     virtual void getInitialConditions(doublereal t0, size_t leny,
                                       doublereal* y);

include/cantera/zeroD/ReactorNet.h

@@ -193,6 +193,8 @@ public:
     }
     virtual void eval(doublereal t, doublereal* y,
                       doublereal* ydot, doublereal* p);
+
+    //! @deprecated Use getState instead. To be removed after Cantera 2.3.
     virtual void getInitialConditions(doublereal t0, size_t leny,
                                       doublereal* y);
     virtual void getState(doublereal* y);

src/kinetics/ImplicitSurfChem.cpp

@@ -102,6 +102,8 @@ int ImplicitSurfChem::checkMatch(std::vector<ThermoPhase*> m_vec, ThermoPhase* t
 void ImplicitSurfChem::getInitialConditions(doublereal t0, size_t lenc,
         doublereal* c)
 {
+    warn_deprecated("ImplicitSurfChem::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(c);
 }
 

src/numerics/CVodeInt.cpp

@@ -200,7 +200,7 @@ void CVodeInt::initialize(double t0, FuncEval& func)
     if (m_itol == 1 && m_nabs < m_neq) {
         throw CVodeErr("not enough absolute tolerance values specified.");
     }
-    func.getInitialConditions(m_t0, m_neq, N_VDATA(m_y));
+    func.getState(N_VDATA(m_y));
 
     // set options
     m_iopt[MXSTEP] = m_maxsteps;
@@ -247,7 +247,7 @@ void CVodeInt::initialize(double t0, FuncEval& func)
 void CVodeInt::reinitialize(double t0, FuncEval& func)
 {
     m_t0 = t0;
-    func.getInitialConditions(m_t0, m_neq, N_VDATA(m_y));
+    func.getState(N_VDATA(m_y));
 
     // set options
     m_iopt[MXSTEP] = m_maxsteps;

src/numerics/CVodesIntegrator.cpp

@@ -281,7 +281,7 @@ void CVodesIntegrator::initialize(double t0, FuncEval& func)
         throw CVodesErr("not enough absolute tolerance values specified.");
     }
 
-    func.getInitialConditions(m_t0, m_neq, NV_DATA_S(m_y));
+    func.getState(NV_DATA_S(m_y));
 
     if (m_cvode_mem) {
         CVodeFree(&m_cvode_mem);
@@ -344,8 +344,7 @@ void CVodesIntegrator::reinitialize(double t0, FuncEval& func)
 {
     m_t0 = t0;
     m_time = t0;
-    func.getInitialConditions(m_t0, static_cast<sd_size_t>(m_neq),
+    func.getState(NV_DATA_S(m_y));
-                              NV_DATA_S(m_y));
 
     int result;
     result = CVodeReInit(m_cvode_mem, m_t0, m_y);

src/zeroD/ConstPressureReactor.cpp

@@ -16,6 +16,8 @@ namespace Cantera
 void ConstPressureReactor::getInitialConditions(double t0, size_t leny,
                                                 double* y)
 {
+    warn_deprecated("ConstPressureReactor::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(y);
 }
 

src/zeroD/FlowReactor.cpp

@@ -26,6 +26,8 @@ FlowReactor::FlowReactor() :
 
 void FlowReactor::getInitialConditions(double t0, size_t leny, double* y)
 {
+    warn_deprecated("FlowReactor::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(y);
 }
 

src/zeroD/IdealGasConstPressureReactor.cpp

@@ -28,6 +28,8 @@ void IdealGasConstPressureReactor::setThermoMgr(ThermoPhase& thermo)
 void IdealGasConstPressureReactor::getInitialConditions(double t0, size_t leny,
                                                         double* y)
 {
+    warn_deprecated("IdealGasConstPressureReactor::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(y);
 }
 

src/zeroD/IdealGasReactor.cpp

@@ -24,6 +24,8 @@ void IdealGasReactor::setThermoMgr(ThermoPhase& thermo)
 
 void IdealGasReactor::getInitialConditions(double t0, size_t leny, double* y)
 {
+    warn_deprecated("IdealGasReactor::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(y);
 }
 

src/zeroD/Reactor.cpp

@@ -29,6 +29,8 @@ Reactor::Reactor() :
 
 void Reactor::getInitialConditions(double t0, size_t leny, double* y)
 {
+    warn_deprecated("Reactor::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(y);
 }
 

src/zeroD/ReactorNet.cpp

@@ -177,6 +177,8 @@ void ReactorNet::updateState(doublereal* y)
 
 void ReactorNet::getInitialConditions(double t0, size_t leny, double* y)
 {
+    warn_deprecated("ReactorNet::getInitialConditions",
+        "Use getState instead. To be removed after Cantera 2.3.");
     getState(y);
 }