diff --git a/CHANGELOG.md b/CHANGELOG.md index f4753af668..b5daadd537 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -200,6 +200,9 @@ The `Convert` methods on the `sundials::kokkos:Vector`, classes have been deprecated and will be removed in the next major release. The method `get`, should be used instead. +The `CVodeSetMonitorFn` and `CVodeSetMonitorFrequency` functions have been deprecated and will be +removed in the next major release. + ## Changes to SUNDIALS in release 7.5.0 ### Major Features diff --git a/doc/cvode/guide/source/Usage/index.rst b/doc/cvode/guide/source/Usage/index.rst index 775dbaf1ff..db921fbfb5 100644 --- a/doc/cvode/guide/source/Usage/index.rst +++ b/doc/cvode/guide/source/Usage/index.rst @@ -983,6 +983,8 @@ Main solver optional input functions Modifying the solution in this function will result in undefined behavior. This function is only intended to be used for monitoring the integrator. SUNDIALS must be built with the CMake option ``SUNDIALS_ENABLE_MONITORING``, to utilize this function. See :numref:`Installation` for more information. + .. deprecated:: x.y.z. + .. c:function:: int CVodeSetMonitorFrequency(void* cvode_mem, long int nst) The function ``CVodeSetMonitorFrequency`` specifies the interval, measured in successfully completed CVODE time-steps, at which the monitor function should be called. @@ -1005,6 +1007,8 @@ Main solver optional input functions Modifying the solution in this function will result in undefined behavior. This function is only intended to be used for monitoring the integrator. SUNDIALS must be built with the CMake option ``SUNDIALS_ENABLE_MONITORING``, to utilize this function. See :numref:`Installation` for more information. + .. deprecated:: x.y.z. + .. c:function:: int CVodeSetMaxOrd(void* cvode_mem, int maxord) The function ``CVodeSetMaxOrd`` specifies the maximum order of the linear multistep method. diff --git a/doc/cvodes/guide/source/Usage/SIM.rst b/doc/cvodes/guide/source/Usage/SIM.rst index a78660f764..3f8aa0008d 100644 --- a/doc/cvodes/guide/source/Usage/SIM.rst +++ b/doc/cvodes/guide/source/Usage/SIM.rst @@ -989,6 +989,8 @@ Main solver optional input functions Modifying the solution in this function will result in undefined behavior. This function is only intended to be used for monitoring the integrator. SUNDIALS must be built with the CMake option ``SUNDIALS_ENABLE_MONITORING``, to utilize this function. See :numref:`Installation` for more information. + .. deprecated:: x.y.z. + .. c:function:: int CVodeSetMonitorFrequency(void* cvode_mem, long int nst) The function ``CVodeSetMonitorFrequency`` specifies the interval, measured in successfully completed CVODES time-steps, at which the monitor function should be called. @@ -1011,6 +1013,8 @@ Main solver optional input functions Modifying the solution in this function will result in undefined behavior. This function is only intended to be used for monitoring the integrator. SUNDIALS must be built with the CMake option ``SUNDIALS_ENABLE_MONITORING``, to utilize this function. See :numref:`Installation` for more information. + .. deprecated:: x.y.z. + .. c:function:: int CVodeSetMaxOrd(void* cvode_mem, int maxord) The function ``CVodeSetMaxOrd`` specifies the maximum order of the linear multistep method. diff --git a/doc/shared/RecentChanges.rst b/doc/shared/RecentChanges.rst index ba72979476..c621eb1f94 100644 --- a/doc/shared/RecentChanges.rst +++ b/doc/shared/RecentChanges.rst @@ -20,6 +20,9 @@ did not disable the corresponding logging stream `Issue #844 u, t); - PrintStats(cvode_mem, data->linsolver, 0); - - return (0); -} diff --git a/include/cvode/cvode.h b/include/cvode/cvode.h index 3e37ebbf65..e08f462e0a 100644 --- a/include/cvode/cvode.h +++ b/include/cvode/cvode.h @@ -97,6 +97,7 @@ typedef int (*CVRootFn)(sunrealtype t, N_Vector y, sunrealtype* gout_1d, typedef int (*CVEwtFn)(N_Vector y, N_Vector ewt, void* user_data); +/* DEPRECATION NOTICE: this will be removed in v8.0.0 */ typedef int (*CVMonitorFn)(void* cvode_mem, void* user_data); /* ------------------- @@ -141,8 +142,10 @@ SUNDIALS_EXPORT int CVodeSetMaxNumSteps(void* cvode_mem, long int mxsteps); SUNDIALS_EXPORT int CVodeSetMaxOrd(void* cvode_mem, int maxord); SUNDIALS_EXPORT int CVodeSetMaxStep(void* cvode_mem, sunrealtype hmax); SUNDIALS_EXPORT int CVodeSetMinStep(void* cvode_mem, sunrealtype hmin); -SUNDIALS_EXPORT int CVodeSetMonitorFn(void* cvode_mem, CVMonitorFn fn); -SUNDIALS_EXPORT int CVodeSetMonitorFrequency(void* cvode_mem, long int nst); +SUNDIALS_DEPRECATED_EXPORT +int CVodeSetMonitorFn(void* cvode_mem, CVMonitorFn fn); +SUNDIALS_DEPRECATED_EXPORT +int CVodeSetMonitorFrequency(void* cvode_mem, long int nst); SUNDIALS_EXPORT int CVodeSetNlsRhsFn(void* cvode_mem, CVRhsFn f); SUNDIALS_EXPORT int CVodeSetNonlinConvCoef(void* cvode_mem, sunrealtype nlscoef); SUNDIALS_EXPORT int CVodeSetNonlinearSolver(void* cvode_mem, diff --git a/include/cvodes/cvodes.h b/include/cvodes/cvodes.h index 0319d04068..f5e7621a85 100644 --- a/include/cvodes/cvodes.h +++ b/include/cvodes/cvodes.h @@ -141,6 +141,7 @@ typedef int (*CVRootFn)(sunrealtype t, N_Vector y, sunrealtype* gout_1d, typedef int (*CVEwtFn)(N_Vector y, N_Vector ewt, void* user_data); +/* DEPRECATION NOTICE: this will be removed in v8.0.0 */ typedef int (*CVMonitorFn)(void* cvode_mem, void* user_data); typedef int (*CVQuadRhsFn)(sunrealtype t, N_Vector y, N_Vector yQdot, @@ -210,8 +211,10 @@ SUNDIALS_EXPORT int CVodeSetMaxNumSteps(void* cvode_mem, long int mxsteps); SUNDIALS_EXPORT int CVodeSetMaxOrd(void* cvode_mem, int maxord); SUNDIALS_EXPORT int CVodeSetMaxStep(void* cvode_mem, sunrealtype hmax); SUNDIALS_EXPORT int CVodeSetMinStep(void* cvode_mem, sunrealtype hmin); -SUNDIALS_EXPORT int CVodeSetMonitorFn(void* cvode_mem, CVMonitorFn fn); -SUNDIALS_EXPORT int CVodeSetMonitorFrequency(void* cvode_mem, long int nst); +SUNDIALS_DEPRECATED_EXPORT +int CVodeSetMonitorFn(void* cvode_mem, CVMonitorFn fn); +SUNDIALS_DEPRECATED_EXPORT +int CVodeSetMonitorFrequency(void* cvode_mem, long int nst); SUNDIALS_EXPORT int CVodeSetNlsRhsFn(void* cvode_mem, CVRhsFn f); SUNDIALS_EXPORT int CVodeSetNonlinConvCoef(void* cvode_mem, sunrealtype nlscoef); SUNDIALS_EXPORT int CVodeSetNonlinearSolver(void* cvode_mem,