diff --git a/include/cantera/oneD/Domain1D.h b/include/cantera/oneD/Domain1D.h index 252cbded1..7c28fe379 100644 --- a/include/cantera/oneD/Domain1D.h +++ b/include/cantera/oneD/Domain1D.h @@ -9,6 +9,7 @@ #include "cantera/base/stringUtils.h" #include "cantera/base/ctexceptions.h" +#include "cantera/base/global.h" #include "refine.h" namespace Cantera @@ -218,7 +219,10 @@ public: m_name[n] = name; } + //! @deprecated To be removed after Cantera 2.3 void setComponentType(size_t n, int ctype) { + warn_deprecated("Domain1D::setComponentType", + "To be removed after Cantera 2.3."); if (ctype == 0) { setAlgebraic(n); } @@ -338,14 +342,18 @@ public: /*! * Evaluate the steady-state residual at all points, even if in * transient mode. Used only to print diagnostic output. + * @deprecated To be removed after Cantera 2.3 */ void evalss(doublereal* x, doublereal* r, integer* mask) { + warn_deprecated("Domain1D::evalss", "To be removed after Cantera 2.3"); eval(npos,x,r,mask,0.0); } //! Evaluate the residual function at point j. If j == npos, //! evaluate the residual function at all points. /*! + * This function must be implemented in classes derived from Domain1D. + * * @param j Grid point at which to update the residual * @param[in] x State vector * @param[out] r residual vector @@ -357,23 +365,41 @@ public: virtual void eval(size_t j, doublereal* x, doublereal* r, integer* mask, doublereal rdt=0.0); + //! @deprecated To be removed after Cantera 2.3. Derived classes should + //! implement eval() instead. virtual doublereal residual(doublereal* x, size_t n, size_t j) { + warn_deprecated("Domain1D::residual", "To be removed after Cantera 2.3."); throw CanteraError("Domain1D::residual","residual function must be overloaded in derived class "+id()); } + //! @deprecated To be removed after Cantera 2.3 int timeDerivativeFlag(size_t n) { + warn_deprecated("Domain1D::timeDerivativeFlag", + "To be removed after Cantera 2.3."); return m_td[n]; } + + //! @deprecated To be removed after Cantera 2.3 void setAlgebraic(size_t n) { + warn_deprecated("Domain1D::setAlgebraic", + "To be removed after Cantera 2.3."); m_td[n] = 0; } - virtual void update(doublereal* x) {} + //! @deprecated To be removed after Cantera 2.3 + virtual void update(doublereal* x) { + warn_deprecated("Domain1D::update", "To be removed after Cantera 2.3."); + } + //! @deprecated To be removed after Cantera 2.3 doublereal time() const { + warn_deprecated("Domain1D::time", "To be removed after Cantera 2.3."); return m_time; } + //! @deprecated To be removed after Cantera 2.3 void incrementTime(doublereal dt) { + warn_deprecated("Domain1D::incrementTime", + "To be removed after Cantera 2.3."); m_time += dt; } size_t index(size_t n, size_t j) const { @@ -512,14 +538,23 @@ public: } //! Specify descriptive text for this domain. + //! @deprecated To be removed after Cantera 2.3. void setDesc(const std::string& s) { + warn_deprecated("Domain1D::setDesc", "To be removed after Cantera 2.3."); m_desc = s; } + + //! @deprecated To be removed after Cantera 2.3. const std::string& desc() { + warn_deprecated("Domain1D::desc", "To be removed after Cantera 2.3."); return m_desc; } - virtual void getTransientMask(integer* mask) {} + //! @deprecated To be removed after Cantera 2.3. + virtual void getTransientMask(integer* mask) { + warn_deprecated("Domain1D::getTransientMask", + "To be removed after Cantera 2.3."); + } virtual void showSolution_s(std::ostream& s, const doublereal* x) {} @@ -589,7 +624,7 @@ protected: size_t m_nv; size_t m_points; vector_fp m_slast; - doublereal m_time; + doublereal m_time; //!< @deprecated To be removed after Cantera 2.3. vector_fp m_max; vector_fp m_min; vector_fp m_rtol_ss, m_rtol_ts; @@ -614,7 +649,7 @@ protected: std::string m_id; std::string m_desc; std::unique_ptr m_refiner; - vector_int m_td; + vector_int m_td; //!< @deprecated To be removed after Cantera 2.3. std::vector m_name; int m_bw; }; diff --git a/src/oneD/Domain1D.cpp b/src/oneD/Domain1D.cpp index 98313aef7..23220e4f6 100644 --- a/src/oneD/Domain1D.cpp +++ b/src/oneD/Domain1D.cpp @@ -48,6 +48,10 @@ void Domain1D::needJacUpdate() void Domain1D::eval(size_t jg, doublereal* xg, doublereal* rg, integer* mask, doublereal rdt) { + warn_deprecated("Domain1D::eval", + "Derived classes should implement eval directly. The 'residual' method" + " will be removed after Cantera 2.3."); + if (jg != npos && (jg + 1 < firstPoint() || jg > lastPoint() + 1)) { return; }