diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index d0d20d539f..51ab03ac92 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -2,3 +2,5 @@ fab1cecb7d91cff53b31730af5d00ff154c3b6ce # Remove deprecated types in 7.0.0 cc6960349aa92e2bcad9168a6dacff99b21c329c +# Apply formatting to Fortran files +23581e8454955283139e551a7bcd1b85d8b7c77b diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b94e65798..059d8d3666 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # SUNDIALS Changelog -## Changes to SUNDIALS in release X.Y.Z +## Changes to SUNDIALS in release 7.1.0 ### Major Features diff --git a/CITATIONS.md b/CITATIONS.md index bdbe0f33e1..ef97b2c715 100644 --- a/CITATIONS.md +++ b/CITATIONS.md @@ -69,7 +69,7 @@ they are using rather than the combined SUNDIALS online guide: author = {Daniel R. Reynolds and David J. Gardner and Carol S. Woodward and Cody J. Balos}, title = {User Documentation for ARKODE}, year = {2024}, - note = {v6.0.0} + note = {v6.1.0} } ``` @@ -78,7 +78,7 @@ they are using rather than the combined SUNDIALS online guide: author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, title = {User Documentation for CVODE}, year = {2024}, - note = {v7.0.0} + note = {v7.1.0} } ``` @@ -87,7 +87,7 @@ they are using rather than the combined SUNDIALS online guide: author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, title = {User Documentation for CVODES}, year = {2024}, - note = {v7.0.0} + note = {v7.1.0} } ``` @@ -96,7 +96,7 @@ they are using rather than the combined SUNDIALS online guide: author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, title = {User Documentation for IDA}, year = {2024}, - note = {v7.0.0} + note = {v7.1.0} } ``` @@ -105,7 +105,7 @@ they are using rather than the combined SUNDIALS online guide: author = {Radu Serban and Cosmin Petra and Alan C. Hindmarsh and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, title = {User Documentation for IDAS}, year = {2024}, - note = {v6.0.0} + note = {v6.1.0} } ``` @@ -114,6 +114,6 @@ they are using rather than the combined SUNDIALS online guide: author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, title = {User Documentation for KINSOL}, year = {2024}, - note = {v7.0.0} + note = {v7.1.0} } ``` diff --git a/CMakeLists.txt b/CMakeLists.txt index 9c2279f4e2..0f8fa7933f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -48,7 +48,7 @@ include(FindPackageHandleStandardArgs) # Set some variables with info on the SUNDIALS project set(PACKAGE_BUGREPORT "sundials-users@llnl.gov") set(PACKAGE_NAME "SUNDIALS") -set(PACKAGE_STRING "SUNDIALS 7.0.0") +set(PACKAGE_STRING "SUNDIALS 7.1.0") set(PACKAGE_TARNAME "sundials") # Set SUNDIALS version numbers @@ -57,7 +57,7 @@ message(STATUS "SUNDIALS_GIT_VERSION: ${SUNDIALS_GIT_VERSION}") # (use "" for the version label if none is needed) set(PACKAGE_VERSION_MAJOR "7") -set(PACKAGE_VERSION_MINOR "0") +set(PACKAGE_VERSION_MINOR "1") set(PACKAGE_VERSION_PATCH "0") set(PACKAGE_VERSION_LABEL "") @@ -73,37 +73,37 @@ endif() # Specify the VERSION and SOVERSION for shared libraries -set(arkodelib_VERSION "6.0.0") +set(arkodelib_VERSION "6.1.0") set(arkodelib_SOVERSION "6") -set(cvodelib_VERSION "7.0.0") +set(cvodelib_VERSION "7.1.0") set(cvodelib_SOVERSION "7") -set(cvodeslib_VERSION "7.0.0") +set(cvodeslib_VERSION "7.1.0") set(cvodeslib_SOVERSION "7") -set(idalib_VERSION "7.0.0") +set(idalib_VERSION "7.1.0") set(idalib_SOVERSION "7") -set(idaslib_VERSION "6.0.0") +set(idaslib_VERSION "6.1.0") set(idaslib_SOVERSION "6") -set(kinsollib_VERSION "7.0.0") +set(kinsollib_VERSION "7.1.0") set(kinsollib_SOVERSION "7") set(cpodeslib_VERSION "0.0.0") set(cpodeslib_SOVERSION "0") -set(nveclib_VERSION "7.0.0") +set(nveclib_VERSION "7.1.0") set(nveclib_SOVERSION "7") -set(sunmatrixlib_VERSION "5.0.0") +set(sunmatrixlib_VERSION "5.1.0") set(sunmatrixlib_SOVERSION "5") -set(sunlinsollib_VERSION "5.0.0") +set(sunlinsollib_VERSION "5.1.0") set(sunlinsollib_SOVERSION "5") -set(sunnonlinsollib_VERSION "4.0.0") +set(sunnonlinsollib_VERSION "4.1.0") set(sunnonlinsollib_SOVERSION "4") set(sundialslib_VERSION diff --git a/README.md b/README.md index d143fbbc69..9a21db1d4d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # SUNDIALS: SUite of Nonlinear and DIfferential/ALgebraic equation Solvers # -### Version 7.0.0 (Feb 2024) ### +### Version 7.1.0 (Jun 2024) ### **Center for Applied Scientific Computing, Lawrence Livermore National Laboratory** diff --git a/doc/arkode/guide/source/ARKodeButcherTable.rst b/doc/arkode/guide/source/ARKodeButcherTable.rst index 6475ee766e..97ccdc96e5 100644 --- a/doc/arkode/guide/source/ARKodeButcherTable.rst +++ b/doc/arkode/guide/source/ARKodeButcherTable.rst @@ -168,7 +168,7 @@ ARKodeButcherTable functions * The name associated with *emethod*. * ``NULL`` pointer if *emethod* was invalid. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: ARKodeButcherTable ARKodeButcherTable_LoadDIRK(ARKODE_DIRKTableID imethod) @@ -219,7 +219,7 @@ ARKodeButcherTable functions * The name associated with *imethod*. * ``NULL`` pointer if *imethod* was invalid. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: ARKodeButcherTable ARKodeButcherTable_Alloc(int stages, sunbooleantype embedded) diff --git a/doc/arkode/guide/source/Introduction.rst b/doc/arkode/guide/source/Introduction.rst index a8e4d53d20..7427e78f0a 100644 --- a/doc/arkode/guide/source/Introduction.rst +++ b/doc/arkode/guide/source/Introduction.rst @@ -126,7 +126,7 @@ require a linear solver, ARKODE may use a variety of SUNLinearSolver modules provided with SUNDIALS, or again may utilize a user-supplied module. -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 6.1.0 ==================================== .. include:: ../../../shared/RecentChanges.rst diff --git a/doc/arkode/guide/source/Usage/ARKStep/Relaxation.rst b/doc/arkode/guide/source/Usage/ARKStep/Relaxation.rst index da267bf1ee..ed7ba1fd64 100644 --- a/doc/arkode/guide/source/Usage/ARKStep/Relaxation.rst +++ b/doc/arkode/guide/source/Usage/ARKStep/Relaxation.rst @@ -69,7 +69,7 @@ Enabling or Disabling Relaxation .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxFn` instead. @@ -98,7 +98,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxEtaFail` instead. @@ -124,7 +124,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxLowerBound` instead. @@ -150,7 +150,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxUpperBound` instead. @@ -174,7 +174,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxMaxFails` instead. @@ -202,7 +202,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxMaxIters` instead. @@ -223,7 +223,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxSolver` instead. @@ -253,7 +253,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxResTol` instead. @@ -284,7 +284,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxTol` instead. @@ -309,7 +309,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxFnEvals` instead. @@ -328,7 +328,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxJacEvals` instead. @@ -352,7 +352,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxFails` instead. @@ -372,7 +372,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxBoundFails` instead. @@ -391,7 +391,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxSolveFails` instead. @@ -410,6 +410,6 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxSolveIters` instead. diff --git a/doc/arkode/guide/source/Usage/ARKStep/User_callable.rst b/doc/arkode/guide/source/Usage/ARKStep/User_callable.rst index 383c3795ea..a6c07ac5e6 100644 --- a/doc/arkode/guide/source/Usage/ARKStep/User_callable.rst +++ b/doc/arkode/guide/source/Usage/ARKStep/User_callable.rst @@ -74,7 +74,7 @@ ARKStep initialization and deallocation functions **Return value:** None - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeFree` instead. @@ -100,7 +100,7 @@ ARKStep tolerance specification functions * *ARK_NO_MALLOC* if the ARKStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSStolerances` instead. @@ -123,7 +123,7 @@ ARKStep tolerance specification functions * *ARK_NO_MALLOC* if the ARKStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSVtolerances` instead. @@ -143,7 +143,7 @@ ARKStep tolerance specification functions * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` * *ARK_NO_MALLOC* if the ARKStep memory was not allocated by the time-stepping module - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWFtolerances` instead. @@ -163,7 +163,7 @@ ARKStep tolerance specification functions * *ARK_NO_MALLOC* if the ARKStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeResStolerance` instead. @@ -183,7 +183,7 @@ ARKStep tolerance specification functions * *ARK_NO_MALLOC* if the ARKStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeResVtolerance` instead. @@ -203,7 +203,7 @@ ARKStep tolerance specification functions * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` * *ARK_NO_MALLOC* if the ARKStep memory was not allocated by the time-stepping module - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeResFtolerance` instead. @@ -256,7 +256,7 @@ Linear solver interface functions insufficient to store :math:`\mathcal{A}` then it will need to be resized internally by ARKStep. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinearSolver` instead. @@ -318,7 +318,7 @@ Mass matrix solver specification functions mass-matrix-times-vector product routine (see :c:type:`ARKLsMassTimesVecFn` and :c:func:`ARKStepSetMassTimes()`). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMassLinearSolver` instead. @@ -350,7 +350,7 @@ Nonlinear solver interface functions default; a call to this routine replaces that module with the supplied *NLS* object. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinearSolver` instead. @@ -389,7 +389,7 @@ Rootfinding initialization function problem but the prior one did, then call *ARKStepRootInit* with *nrtfn = 0*. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeRootInit` instead. @@ -508,7 +508,7 @@ ARKStep solver function On all other error returns, *tret* and *yout* are left unchanged from those provided to the routine. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeEvolve` instead. @@ -545,14 +545,14 @@ Optional inputs for ARKStep Also leaves alone any data structures or options related to root-finding (those can be reset using :c:func:`ARKStepRootInit()`). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDefaults` instead. .. c:function:: int ARKStepSetInterpolantType(void* arkode_mem, int itype) - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 This function is now a wrapper to :c:func:`ARKodeSetInterpolantType`, see the documentation for that function instead. @@ -598,7 +598,7 @@ Optional inputs for ARKStep obtained by the integrator are returned at the ends of the time interval. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolantDegree` instead. @@ -694,7 +694,7 @@ Optional inputs for ARKStep routines will provide no useful information to the solver, and at worst they may interfere with the desired fixed step size. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetFixedStep` instead. @@ -724,7 +724,7 @@ Optional inputs for ARKStep This routine will also reset the step size and error history. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInitStep` instead. @@ -750,7 +750,7 @@ Optional inputs for ARKStep A negative value indicates that no warning messages should be issued. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxHnilWarns` instead. @@ -776,7 +776,7 @@ Optional inputs for ARKStep Passing *mxsteps* < 0 disables the test (not recommended). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNumSteps` instead. @@ -797,7 +797,7 @@ Optional inputs for ARKStep **Notes:** Pass *hmax* :math:`\le 0.0` to set the default value of :math:`\infty`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxStep` instead. @@ -818,7 +818,7 @@ Optional inputs for ARKStep **Notes:** Pass *hmin* :math:`\le 0.0` to set the default value of 0. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMinStep` instead. @@ -848,7 +848,7 @@ Optional inputs for ARKStep :c:func:`ARKStepReset` will remain active but can be disabled by calling :c:func:`ARKStepClearStopTime`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStopTime` instead. @@ -869,7 +869,7 @@ Optional inputs for ARKStep .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolateStopTime` instead. @@ -891,7 +891,7 @@ Optional inputs for ARKStep .. versionadded:: 5.5.1 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeClearStopTime` instead. @@ -919,7 +919,7 @@ Optional inputs for ARKStep this function must be made *before* any calls to :c:func:`ARKStepSetLinearSolver()` and/or :c:func:`ARKStepSetMassLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetUserData` instead. @@ -942,7 +942,7 @@ Optional inputs for ARKStep The default value is 7; set *maxnef* :math:`\le 0` to specify this default. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxErrTestFails` instead. @@ -968,7 +968,7 @@ Optional inputs for ARKStep all problems are different, so these values may not be optimal for all users. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Adjust solver parameters individually instead. For reference, this routine sets the following non-default parameters: @@ -1154,7 +1154,7 @@ Optional inputs for ARKStep and :c:func:`ARKStepSetFixedStep()` are incompatible, and should not be used simultaneously. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetConstraints` instead. @@ -1176,7 +1176,7 @@ Optional inputs for ARKStep Passing *maxfails* <= 0 results in ARKStep using the default value (10). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNumConstrFails` instead. @@ -1227,7 +1227,7 @@ Set additive RK tables via their names :c:func:`ARKStepSetTableName()` int ARKStep memory block, it cannot be changed after the first call to :c:func:`ARKStepEvolve()`, unless :c:func:`ARKStepReInit()` is called. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetOrder` instead. @@ -1459,7 +1459,7 @@ Optional inputs for time step adaptivity .. versionadded:: 5.7.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetAdaptController` instead. @@ -1557,7 +1557,7 @@ Optional inputs for time step adaptivity .. versionadded:: 5.7.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetAdaptivityAdjustment` instead. @@ -1580,7 +1580,7 @@ Optional inputs for time step adaptivity Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetCFLFraction` instead. @@ -1629,7 +1629,7 @@ Optional inputs for time step adaptivity **Notes:** Any interval *not* containing 1.0 will imply a reset to the default values. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetFixedStepBounds` instead. @@ -1653,7 +1653,7 @@ Optional inputs for time step adaptivity **Notes:** Any value outside the interval :math:`(0,1]` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxCFailGrowth` instead. @@ -1675,7 +1675,7 @@ Optional inputs for time step adaptivity **Notes:** Any value outside the interval :math:`(0,1]` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxEFailGrowth` instead. @@ -1698,7 +1698,7 @@ Optional inputs for time step adaptivity **Notes:** Any value :math:`\le 1.0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxFirstGrowth` instead. @@ -1721,7 +1721,7 @@ Optional inputs for time step adaptivity Any value :math:`\le 1.0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxGrowth` instead. @@ -1746,7 +1746,7 @@ Optional inputs for time step adaptivity Any value outside the interval :math:`(0,1)` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMinReduction` instead. @@ -1769,7 +1769,7 @@ Optional inputs for time step adaptivity Any value :math:`\le 0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetSafetyFactor` instead. @@ -1792,7 +1792,7 @@ Optional inputs for time step adaptivity **Notes:** Any value :math:`\le 0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetSmallNumEFails` instead. @@ -1821,7 +1821,7 @@ Optional inputs for time step adaptivity be quite useful for problems where the explicit right-hand side function :math:`f^E(t,y)` contains stiff terms. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStabilityFn` instead. @@ -1861,7 +1861,7 @@ Optional inputs for implicit stage solves stage. Thus one must balance the relative costs of such recomputation against the benefits of requiring only a single Newton linear solve. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinear` instead. @@ -1885,7 +1885,7 @@ Optional inputs for implicit stage solves :c:func:`ARKStepSetDeltaGammaMax()` to reset the step size ratio threshold to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinear` instead. @@ -1933,7 +1933,7 @@ Optional inputs for implicit stage solves instead default to the trivial predictor (*method* 0). **Both of these options have been deprecated, and will be removed from a future release.** - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetPredictorMethod` instead. @@ -1956,7 +1956,7 @@ Optional inputs for implicit stage solves See :numref:`ARKODE.Usage.StagePredictFn` for more information on this user-supplied routine. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStagePredictFn` instead. @@ -1984,7 +1984,7 @@ Optional inputs for implicit stage solves When using a non-default nonlinear solver, this function must be called *after* :c:func:`ARKStepSetNonlinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNlsRhsFn` instead. @@ -2008,7 +2008,7 @@ Optional inputs for implicit stage solves The default value is 3; set *maxcor* :math:`\le 0` to specify this default. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNonlinIters` instead. @@ -2031,7 +2031,7 @@ Optional inputs for implicit stage solves The default value is 0.1; set *nlscoef* :math:`\le 0` to specify this default. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinConvCoef` instead. @@ -2052,7 +2052,7 @@ Optional inputs for implicit stage solves **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinCRDown` instead. @@ -2075,7 +2075,7 @@ Optional inputs for implicit stage solves **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinRDiv` instead. @@ -2106,7 +2106,7 @@ Optional inputs for implicit stage solves convergence failure still occurs, the time step size is reduced by the factor *etacf* (set within :c:func:`ARKStepSetMaxCFailGrowth()`). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxConvFails` instead. @@ -2129,7 +2129,7 @@ Optional inputs for implicit stage solves .. versionadded:: 5.2.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDeduceImplicitRhs` instead. @@ -2167,7 +2167,7 @@ Optional inputs for the ARKLS linear solver interface **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDeltaGammaMax` instead. @@ -2193,7 +2193,7 @@ Optional inputs for the ARKLS linear solver interface step. If **msbp** is 0, the default value of 20 will be used. A negative value forces a linear solver step at each implicit stage. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLSetupFrequency` instead. @@ -2230,7 +2230,7 @@ Optional inputs for the ARKLS linear solver interface This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`ARKStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacEvalFrequency` instead. @@ -2272,7 +2272,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules The function type :c:func:`ARKLsJacFn()` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacFn` instead. @@ -2303,7 +2303,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules The function type :c:func:`ARKLsLinSysFn()` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinSysFn` instead. @@ -2334,7 +2334,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules The function type :c:func:`ARKLsMassFn()` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMassFn` instead. @@ -2359,7 +2359,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules Linear solution scaling is enabled by default when a matrix-based linear solver is attached. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinearSolutionScaling` instead. @@ -2403,7 +2403,7 @@ Optional inputs for matrix-free ``SUNLinearSolver`` modules :c:type:`ARKLsJacTimesVecFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacTimes` instead. @@ -2433,7 +2433,7 @@ Optional inputs for matrix-free ``SUNLinearSolver`` modules This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`ARKStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacTimesRhsFn` instead. @@ -2474,7 +2474,7 @@ Optional inputs for matrix-free ``SUNLinearSolver`` modules :c:type:`ARKLsMassTimesVecFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMassTimes` instead. @@ -2517,7 +2517,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules :c:func:`ARKLsPrecSolveFn()` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetPreconditioner` instead. @@ -2553,7 +2553,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules :c:func:`ARKLsMassPrecSolveFn()` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMassPreconditioner` instead. @@ -2582,7 +2582,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules interface has been initialized through a call to :c:func:`ARKStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetEpsLin` instead. @@ -2611,7 +2611,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules Passing a value *eplifac* :math:`\le 0` indicates to use the default value of 0.05. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMassEpsLin` instead. @@ -2643,7 +2643,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`ARKStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLSNormFactor` instead. @@ -2675,7 +2675,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules This function must be called *after* the ARKLS mass matrix solver interface has been initialized through a call to :c:func:`ARKStepSetMassLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMassLSNormFactor` instead. @@ -2706,7 +2706,7 @@ Rootfinding optional input functions **Notes:** The default behavior is to monitor for both zero-crossing directions. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRootDirection` instead. @@ -2732,7 +2732,7 @@ Rootfinding optional input functions first step), ARKStep will issue a warning which can be disabled with this optional input function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNoInactiveRootWarn` instead. @@ -2781,7 +2781,7 @@ Interpolated output function functions :c:func:`ARKStepGetCurrentTime()` and :c:func:`ARKStepGetLastStep()`, respectively. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetDky` instead. @@ -2811,7 +2811,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetWorkSpace` instead. @@ -2829,7 +2829,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumSteps` instead. @@ -2855,7 +2855,7 @@ Main solver optional output functions local error test condition, or to ensure convergence of the nonlinear solver. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetActualInitStep` instead. @@ -2873,7 +2873,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastStep` instead. @@ -2890,7 +2890,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentStep` instead. @@ -2907,7 +2907,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentTime` instead. @@ -2929,7 +2929,7 @@ Main solver optional output functions as altering values of *ycur* may lead to undesirable behavior, depending on the particular use case and on when this routine is called. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentState` instead. @@ -2947,7 +2947,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentGamma` instead. @@ -2966,7 +2966,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetTolScaleFactor` instead. @@ -2987,7 +2987,7 @@ Main solver optional output functions The user must allocate space for *eweight*, that will be filled in by this function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetErrWeights` instead. @@ -3008,7 +3008,7 @@ Main solver optional output functions The user must allocate space for *rweight*, that will be filled in by this function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetResWeights` instead. @@ -3029,7 +3029,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetStepStats` instead. @@ -3061,7 +3061,7 @@ Main solver optional output functions .. versionadded:: 5.2.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodePrintAllStats` instead. @@ -3078,7 +3078,7 @@ Main solver optional output functions The return value is a string containing the name of the corresponding constant. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetReturnFlagName` instead. @@ -3097,7 +3097,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumExpSteps` instead. @@ -3115,7 +3115,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumAccSteps` instead. @@ -3132,7 +3132,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumStepAttempts` instead. @@ -3170,7 +3170,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumErrTestFails` instead. @@ -3187,7 +3187,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumStepSolveFails` instead. @@ -3255,7 +3255,7 @@ Main solver optional output functions failures, the components causing the failures are those with largest values for the products, denoted loosely as ``eweight[i]*ele[i]``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetEstLocalErrors` instead. @@ -3292,7 +3292,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumConstrFails` instead. @@ -3312,7 +3312,7 @@ Main solver optional output functions .. versionadded:: 5.3.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetUserData` instead. @@ -3339,7 +3339,7 @@ Implicit solver optional output functions solver object; the counter is reset whenever a new nonlinear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinSolvSetups` instead. @@ -3362,7 +3362,7 @@ Implicit solver optional output functions solver object; the counter is reset whenever a new nonlinear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumNonlinSolvIters` instead. @@ -3384,7 +3384,7 @@ Implicit solver optional output functions solver object; the counter is reset whenever a new nonlinear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumNonlinSolvConvFails` instead. @@ -3407,7 +3407,7 @@ Implicit solver optional output functions solver object; the counters are reset whenever a new nonlinear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNonlinSolvStats` instead. @@ -3445,7 +3445,7 @@ Rootfinding optional output functions zero-crossing. A value of +1 indicates that :math:`g_i` is increasing, while a value of -1 indicates a decreasing :math:`g_i`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetRootInfo` instead. @@ -3463,7 +3463,7 @@ Rootfinding optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumGEvals` instead. @@ -3490,7 +3490,7 @@ Linear solver interface optional output functions This function is provided for debugging purposes and the values in the returned matrix should not be altered. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetJac` instead. @@ -3507,7 +3507,7 @@ Linear solver interface optional output functions :retval ARKLS_MEM_NULL: ``arkode_mem`` was ``NULL`` :retval ARKLS_LMEM_NULL: the linear solver interface has not been initialized - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetJacTime` instead. @@ -3524,7 +3524,7 @@ Linear solver interface optional output functions :retval ARKLS_MEM_NULL: ``arkode_mem`` was ``NULL`` :retval ARKLS_LMEM_NULL: the linear solver interface has not been initialized - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetJacNumSteps` instead. @@ -3553,7 +3553,7 @@ Linear solver interface optional output functions In a parallel setting, the above values are global (i.e. summed over all processors). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLinWorkSpace` instead. @@ -3575,7 +3575,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumJacEvals` instead. @@ -3599,7 +3599,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumPrecEvals` instead. @@ -3622,7 +3622,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumPrecSolves` instead. @@ -3644,7 +3644,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinIters` instead. @@ -3666,7 +3666,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinConvFails` instead. @@ -3689,7 +3689,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumJTSetupEvals` instead. @@ -3712,7 +3712,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumJtimesEvals` instead. @@ -3741,7 +3741,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinRhsEvals` instead. @@ -3796,7 +3796,7 @@ Linear solver interface optional output functions *SUN_ERR_EXT_FAIL*, indicating an unrecoverable failure in an external iterative linear solver package. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastLinFlag` instead. @@ -3813,7 +3813,7 @@ Linear solver interface optional output functions ``SUNLINSOL_BAND`` modules, then if 1 :math:`\le` `lsflag` :math:`\le n` (LU factorization failed), this routine returns "NONE". - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLinReturnFlagName` instead. @@ -3843,7 +3843,7 @@ Linear solver interface optional output functions In a parallel setting, the above values are global (i.e. summed over all processors). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetMassWorkSpace` instead. @@ -3868,7 +3868,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassSetups` instead. @@ -3892,7 +3892,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassMultSetups` instead. @@ -3917,7 +3917,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassMult` instead. @@ -3940,7 +3940,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassSolves` instead. @@ -3964,7 +3964,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassPrecEvals` instead. @@ -3988,7 +3988,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassPrecSolves` instead. @@ -4011,7 +4011,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassIters` instead. @@ -4034,7 +4034,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMassConvFails` instead. @@ -4058,7 +4058,7 @@ Linear solver interface optional output functions linear solver module is "attached" to ARKStep, or when ARKStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumMTSetups` instead. @@ -4082,7 +4082,7 @@ Linear solver interface optional output functions will match those described above for the function :c:func:`ARKStepGetLastLinFlag()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastMassFlag` instead. @@ -4114,7 +4114,7 @@ General usability functions for this pointer, since parameters for all processes would be identical. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWriteParameters` instead. @@ -4143,7 +4143,7 @@ General usability functions for this pointer, since tables for all processes would be identical. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKStepGetCurrentButcherTables` and :c:func:`ARKodeButcherTable_Write` instead. @@ -4268,7 +4268,7 @@ ARKStep reset function If an error occurred, :c:func:`ARKStepReset()` also sends an error message to the error handler function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeReset` instead. @@ -4346,7 +4346,7 @@ ARKStep system resize function **Example codes:** * ``examples/arkode/C_serial/ark_heat1D_adapt.c`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeResize` instead. diff --git a/doc/arkode/guide/source/Usage/ARKStep/XBraid.rst b/doc/arkode/guide/source/Usage/ARKStep/XBraid.rst index 4ea9043bcc..665610283a 100644 --- a/doc/arkode/guide/source/Usage/ARKStep/XBraid.rst +++ b/doc/arkode/guide/source/Usage/ARKStep/XBraid.rst @@ -685,7 +685,7 @@ error occurred. The possible return codes are given in :retval SUNBRAID_ILLINPUT: if *app* is ``NULL``. :retval SUNBRAID_MEMFAIL: if the *app* content or ARKStep memory is ``NULL``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKBraid_GetARKodeMem` instead. @@ -744,7 +744,7 @@ error occurred. The possible return codes are given in :retval SUNBRAID_ILLINPUT: if *app* is ``NULL``. :retval SUNBRAID_MEMFAIL: if the *app* content is ``NULL``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKBraid_GetLastARKodeFlag` instead. diff --git a/doc/arkode/guide/source/Usage/ERKStep/Relaxation.rst b/doc/arkode/guide/source/Usage/ERKStep/Relaxation.rst index fec0342371..979e8bff02 100644 --- a/doc/arkode/guide/source/Usage/ERKStep/Relaxation.rst +++ b/doc/arkode/guide/source/Usage/ERKStep/Relaxation.rst @@ -63,7 +63,7 @@ Enabling or Disabling Relaxation .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxFn` instead. @@ -92,7 +92,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxEtaFail` instead. @@ -118,7 +118,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxLowerBound` instead. @@ -144,7 +144,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxUpperBound` instead. @@ -168,7 +168,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxMaxFails` instead. @@ -196,7 +196,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxMaxIters` instead. @@ -217,7 +217,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxSolver` instead. @@ -246,7 +246,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxResTol` instead. @@ -278,7 +278,7 @@ relaxation. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRelaxTol` instead. @@ -303,7 +303,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxFnEvals` instead. @@ -322,7 +322,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxJacEvals` instead. @@ -346,7 +346,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxFails` instead. @@ -367,7 +367,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxBoundFails` instead. @@ -386,7 +386,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxSolveFails` instead. @@ -405,7 +405,7 @@ about the performance of the relaxation method. .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumRelaxSolveIters` instead. diff --git a/doc/arkode/guide/source/Usage/ERKStep/User_callable.rst b/doc/arkode/guide/source/Usage/ERKStep/User_callable.rst index 03a9954b28..017aa17110 100644 --- a/doc/arkode/guide/source/Usage/ERKStep/User_callable.rst +++ b/doc/arkode/guide/source/Usage/ERKStep/User_callable.rst @@ -71,7 +71,7 @@ ERKStep initialization and deallocation functions **Return value:** None - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeFree` instead. @@ -97,7 +97,7 @@ ERKStep tolerance specification functions * *ARK_NO_MALLOC* if the ERKStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSStolerances` instead. @@ -121,7 +121,7 @@ ERKStep tolerance specification functions * *ARK_NO_MALLOC* if the ERKStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSVtolerances` instead. @@ -142,7 +142,7 @@ ERKStep tolerance specification functions * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` * *ARK_NO_MALLOC* if the ERKStep memory was not allocated by the time-stepping module - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWFtolerances` instead. @@ -181,7 +181,7 @@ Rootfinding initialization function problem but the prior one did, then call *ERKStepRootInit* with *nrtfn = 0*. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeRootInit` instead. @@ -283,7 +283,7 @@ ERKStep solver function On all other error returns, *tret* and *yout* are left unchanged from those provided to the routine. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeEvolve` instead. @@ -321,7 +321,7 @@ Optional inputs for ERKStep Also leaves alone any data structures or options related to root-finding (those can be reset using :c:func:`ERKStepRootInit()`). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDefaults` instead. @@ -329,7 +329,7 @@ Optional inputs for ERKStep .. c:function:: int ERKStepSetInterpolantType(void* arkode_mem, int itype) - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 This function is now a wrapper to :c:func:`ARKodeSetInterpolantType`, see the documentation for that function instead. @@ -376,7 +376,7 @@ Optional inputs for ERKStep obtained by the integrator are returned at the ends of the time interval. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolantDegree` instead. @@ -473,7 +473,7 @@ Optional inputs for ERKStep routines will provide no useful information to the solver, and at worst they may interfere with the desired fixed step size. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetFixedStep` instead. @@ -503,7 +503,7 @@ Optional inputs for ERKStep This routine will also reset the step size and error history. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInitStep` instead. @@ -530,7 +530,7 @@ Optional inputs for ERKStep A negative value indicates that no warning messages should be issued. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxHnilWarns` instead. @@ -557,7 +557,7 @@ Optional inputs for ERKStep Passing *mxsteps* < 0 disables the test (not recommended). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNumSteps` instead. @@ -579,7 +579,7 @@ Optional inputs for ERKStep **Notes:** Pass *hmax* :math:`\le 0.0` to set the default value of :math:`\infty`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxStep` instead. @@ -601,7 +601,7 @@ Optional inputs for ERKStep **Notes:** Pass *hmin* :math:`\le 0.0` to set the default value of 0. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMinStep` instead. @@ -632,7 +632,7 @@ Optional inputs for ERKStep :c:func:`ERKStepReset` will remain active but can be disabled by calling :c:func:`ERKStepClearStopTime`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStopTime` instead. @@ -654,7 +654,7 @@ Optional inputs for ERKStep .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolateStopTime` instead. @@ -677,7 +677,7 @@ Optional inputs for ERKStep .. versionadded:: 5.5.1 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeClearStopTime` instead. @@ -702,7 +702,7 @@ Optional inputs for ERKStep user-supplied functions for which it is an argument; otherwise ``NULL`` is passed. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetUserData` instead. @@ -726,7 +726,7 @@ Optional inputs for ERKStep The default value is 7; set *maxnef* :math:`\le 0` to specify this default. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxErrTestFails` instead. @@ -774,7 +774,7 @@ Optional inputs for ERKStep and :c:func:`ERKStepSetFixedStep()` are incompatible, and should not be used simultaneously. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetConstraints` instead. @@ -797,7 +797,7 @@ Optional inputs for ERKStep Passing *maxfails* <= 0 results in ERKStep using the default value (10). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNumConstrFails` instead. @@ -846,7 +846,7 @@ Optional inputs for IVP method selection ERKStep memory block, it cannot be changed after the first call to :c:func:`ERKStepEvolve()`, unless :c:func:`ERKStepReInit()` is called. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetOrder` instead. @@ -963,7 +963,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. .. versionadded:: 5.7.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetAdaptController` instead. @@ -1059,7 +1059,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. .. versionadded:: 5.7.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetAdaptivityAdjustment` instead. @@ -1082,7 +1082,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetCFLFraction` instead. @@ -1133,7 +1133,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. **Notes:** Any interval *not* containing 1.0 will imply a reset to the default values. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetFixedStepBounds` instead. @@ -1156,7 +1156,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. **Notes:** Any value outside the interval :math:`(0,1]` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxEFailGrowth` instead. @@ -1180,7 +1180,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. **Notes:** Any value :math:`\le 1.0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxFirstGrowth` instead. @@ -1204,7 +1204,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. Any value :math:`\le 1.0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxGrowth` instead. @@ -1230,7 +1230,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. Any value :math:`\ge 1.0` or :math:`\le 0.0` will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMinReduction` instead. @@ -1254,7 +1254,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetSafetyFactor` instead. @@ -1278,7 +1278,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetSmallNumEFails` instead. @@ -1308,7 +1308,7 @@ the code, is provided in :numref:`ARKODE.Mathematics.Adaptivity`. where the right-hand side function :math:`f(t,y)` contains stiff terms. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStabilityFn` instead. @@ -1343,7 +1343,7 @@ Rootfinding optional input functions **Notes:** The default behavior is to monitor for both zero-crossing directions. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRootDirection` instead. @@ -1370,7 +1370,7 @@ Rootfinding optional input functions first step), ERKStep will issue a warning which can be disabled with this optional input function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNoInactiveRootWarn` instead. @@ -1419,7 +1419,7 @@ Interpolated output function functions :c:func:`ERKStepGetCurrentTime()` and :c:func:`ERKStepGetLastStep()`, respectively. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetDky` instead. @@ -1450,7 +1450,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetWorkSpace` instead. @@ -1469,7 +1469,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumSteps` instead. @@ -1495,7 +1495,7 @@ Main solver optional output functions bounds :math:`(h_{min} \le h_0 \le h_{max})`, or to satisfy the local error test condition. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetActualInitStep` instead. @@ -1514,7 +1514,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastStep` instead. @@ -1532,7 +1532,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentStep` instead. @@ -1550,7 +1550,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentTime` instead. @@ -1570,7 +1570,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetTolScaleFactor` instead. @@ -1592,7 +1592,7 @@ Main solver optional output functions The user must allocate space for *eweight*, that will be filled in by this function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetErrWeights` instead. @@ -1614,7 +1614,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetStepStats` instead. @@ -1646,7 +1646,7 @@ Main solver optional output functions .. versionadded:: 5.2.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodePrintAllStats` instead. @@ -1664,7 +1664,7 @@ Main solver optional output functions The return value is a string containing the name of the corresponding constant. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetReturnFlagName` instead. @@ -1683,7 +1683,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumExpSteps` instead. @@ -1702,7 +1702,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumAccSteps` instead. @@ -1720,7 +1720,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumStepAttempts` instead. @@ -1754,7 +1754,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumErrTestFails` instead. @@ -1821,7 +1821,7 @@ Main solver optional output functions failures, the components causing the failures are those with largest values for the products, denoted loosely as ``eweight[i]*ele[i]``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetEstLocalErrors` instead. @@ -1857,7 +1857,7 @@ Main solver optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumConstrFails` instead. @@ -1878,7 +1878,7 @@ Main solver optional output functions .. versionadded:: 5.3.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetUserData` instead. @@ -1916,7 +1916,7 @@ Rootfinding optional output functions zero-crossing. A value of +1 indicates that :math:`g_i` is increasing, while a value of -1 indicates a decreasing :math:`g_i`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetRootInfo` instead. @@ -1935,7 +1935,7 @@ Rootfinding optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the ERKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumGEvals` instead. @@ -1967,7 +1967,7 @@ General usability functions for this pointer, since parameters for all processes would be identical. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWriteParameters` instead. @@ -1993,7 +1993,7 @@ General usability functions for this pointer, since tables for all processes would be identical. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ERKStepGetCurrentButcherTable` and :c:func:`ARKodeButcherTable_Write` instead. @@ -2108,7 +2108,7 @@ ERKStep reset function If an error occurred, :c:func:`ERKStepReset()` also sends an error message to the error handler function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeReset` instead. @@ -2154,6 +2154,6 @@ ERKStep system resize function to :c:func:`ERKStepSetConstraints()` is required to re-enable constraint checking. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeResize` instead. diff --git a/doc/arkode/guide/source/Usage/MRIStep/User_callable.rst b/doc/arkode/guide/source/Usage/MRIStep/User_callable.rst index eb92a95ac9..95f13fb608 100644 --- a/doc/arkode/guide/source/Usage/MRIStep/User_callable.rst +++ b/doc/arkode/guide/source/Usage/MRIStep/User_callable.rst @@ -110,7 +110,7 @@ MRIStep initialization and deallocation functions **Return value:** None - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeFree` instead. @@ -136,7 +136,7 @@ MRIStep tolerance specification functions * *ARK_NO_MALLOC* if the MRIStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSStolerances` instead. @@ -160,7 +160,7 @@ MRIStep tolerance specification functions * *ARK_NO_MALLOC* if the MRIStep memory was not allocated by the time-stepping module * *ARK_ILL_INPUT* if an argument has an illegal value (e.g. a negative tolerance). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSVtolerances` instead. @@ -181,7 +181,7 @@ MRIStep tolerance specification functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` * *ARK_NO_MALLOC* if the MRIStep memory was not allocated by the time-stepping module - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWFtolerances` instead. @@ -233,7 +233,7 @@ Linear solver interface functions insufficient to store :math:`\mathcal{A}` then it will need to be resized internally by MRIStep. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinearSolver` instead. @@ -264,7 +264,7 @@ Nonlinear solver interface functions default; a call to this routine replaces that module with the supplied *NLS* object. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinearSolver` instead. @@ -305,7 +305,7 @@ Rootfinding initialization function Rootfinding is only supported for the slow (outer) integrator and should not be actived for the fast (inner) integrator. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeRootInit` instead. @@ -414,7 +414,7 @@ MRIStep solver function On all other error returns, *tret* and *yout* are left unchanged from those provided to the routine. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeEvolve` instead. @@ -454,7 +454,7 @@ Optional inputs for MRIStep structures or options related to root-finding (those can be reset using :c:func:`MRIStepRootInit()`). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDefaults` instead. @@ -462,7 +462,7 @@ Optional inputs for MRIStep .. c:function:: int MRIStepSetInterpolantType(void* arkode_mem, int itype) - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 This function is now a wrapper to :c:func:`ARKodeSetInterpolantType`, see the documentation for that function instead. @@ -514,7 +514,7 @@ Optional inputs for MRIStep When :math:`q=1`, a linear interpolant is the default to ensure values obtained by the integrator are returned at the ends of the time interval. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolantDegree` instead. @@ -584,7 +584,7 @@ Optional inputs for MRIStep The step sizes used by the inner (fast) stepper may be controlled through calling the appropriate "Set" routines on the inner integrator. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetFixedStep` instead. @@ -615,7 +615,7 @@ Optional inputs for MRIStep A negative value indicates that no warning messages should be issued. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxHnilWarns` instead. @@ -646,7 +646,7 @@ Optional inputs for MRIStep Passing *mxsteps* < 0 disables the test (not recommended). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNumSteps` instead. @@ -683,7 +683,7 @@ Optional inputs for MRIStep :c:func:`MRIStepReset` will remain active but can be disabled by calling :c:func:`MRIStepClearStopTime`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStopTime` instead. @@ -705,7 +705,7 @@ Optional inputs for MRIStep .. versionadded:: 5.6.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolateStopTime` instead. @@ -728,7 +728,7 @@ Optional inputs for MRIStep .. versionadded:: 5.5.1 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeClearStopTime` instead. @@ -763,7 +763,7 @@ Optional inputs for MRIStep may be the same as or different from the pointer attached to the outer integrator depending on what is required by the user code. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetUserData` instead. @@ -845,7 +845,7 @@ Optional inputs for IVP method selection * *ARK_MEM_NULL* if the MRIStep memory is ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetOrder` instead. @@ -913,7 +913,7 @@ Optional inputs for implicit stage solves The only SUNDIALS-provided SUNNonlinearSolver module that is compatible with the :c:func:`MRIStepSetLinear()` option is the Newton solver. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinear` instead. @@ -938,7 +938,7 @@ Optional inputs for implicit stage solves :c:func:`MRIStepSetDeltaGammaMax()` to reset the step size ratio threshold to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinear` instead. @@ -978,7 +978,7 @@ Optional inputs for implicit stage solves **The "bootstrap" predictor (option 4 above) has been deprecated, and will be removed from a future release.** - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetPredictorMethod` instead. @@ -1002,7 +1002,7 @@ Optional inputs for implicit stage solves **Notes:** The default value is 3; set *maxcor* :math:`\le 0` to specify this default. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNonlinIters` instead. @@ -1024,7 +1024,7 @@ Optional inputs for implicit stage solves **Notes:** The default value is 0.1; set *nlscoef* :math:`\le 0` to specify this default. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinConvCoef` instead. @@ -1045,7 +1045,7 @@ Optional inputs for implicit stage solves **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinCRDown` instead. @@ -1068,7 +1068,7 @@ Optional inputs for implicit stage solves **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNonlinRDiv` instead. @@ -1091,7 +1091,7 @@ Optional inputs for implicit stage solves **Notes:** See :numref:`ARKODE.Usage.StagePredictFn` for more information on this user-supplied routine. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStagePredictFn` instead. @@ -1119,7 +1119,7 @@ Optional inputs for implicit stage solves When using a non-default nonlinear solver, this function must be called *after* :c:func:`MRIStepSetNonlinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNlsRhsFn` instead. @@ -1143,7 +1143,7 @@ Optional inputs for implicit stage solves .. versionadded:: 5.2.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDeduceImplicitRhs` instead. @@ -1177,7 +1177,7 @@ Optional inputs for the ARKLS linear solver interface **Notes:** Any non-positive parameter will imply a reset to the default value. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDeltaGammaMax` instead. @@ -1203,7 +1203,7 @@ Optional inputs for the ARKLS linear solver interface step. If **msbp** is 0, the default value of 20 will be used. A negative value forces a linear solver step at each implicit stage. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLSetupFrequency` instead. @@ -1236,7 +1236,7 @@ Optional inputs for the ARKLS linear solver interface This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`MRIStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacEvalFrequency` instead. @@ -1274,7 +1274,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules The function type :c:func:`ARKLsJacFn()` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacFn` instead. @@ -1305,7 +1305,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules The function type :c:func:`ARKLsLinSysFn()` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinSysFn` instead. @@ -1330,7 +1330,7 @@ Optional inputs for matrix-based ``SUNLinearSolver`` modules **Notes:** Linear solution scaling is enabled by default when a matrix-based linear solver is attached. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLinearSolutionScaling` instead. @@ -1373,7 +1373,7 @@ Optional inputs for matrix-free ``SUNLinearSolver`` modules :c:type:`ARKLsJacTimesVecFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacTimes` instead. @@ -1401,7 +1401,7 @@ Optional inputs for matrix-free ``SUNLinearSolver`` modules This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`MRIStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetJacTimesRhsFn` instead. @@ -1444,7 +1444,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules :c:func:`ARKLsPrecSolveFn()` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetPreconditioner` instead. @@ -1473,7 +1473,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules interface has been initialized through a call to :c:func:`MRIStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetEpsLin` instead. @@ -1506,7 +1506,7 @@ Optional inputs for iterative ``SUNLinearSolver`` modules This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`MRIStepSetLinearSolver()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetLSNormFactor` instead. @@ -1538,7 +1538,7 @@ Rootfinding optional input functions **Notes:** The default behavior is to monitor for both zero-crossing directions. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRootDirection` instead. @@ -1564,7 +1564,7 @@ Rootfinding optional input functions first step), MRIStep will issue a warning which can be disabled with this optional input function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNoInactiveRootWarn` instead. @@ -1620,7 +1620,7 @@ Interpolated output function functions :c:func:`MRIStepGetCurrentTime()` and :c:func:`MRIStepGetLastStep()`, respectively. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetDky` instead. @@ -1656,7 +1656,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetWorkSpace` instead. @@ -1681,7 +1681,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumSteps` instead. @@ -1704,7 +1704,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastStep` instead. @@ -1726,7 +1726,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentTime` instead. @@ -1751,7 +1751,7 @@ Main solver optional output functions as altering values of *ycur* may lead to undesirable behavior, depending on the particular use case and on when this routine is called. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentState` instead. @@ -1773,7 +1773,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentGamma` instead. @@ -1796,7 +1796,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetTolScaleFactor` instead. @@ -1820,7 +1820,7 @@ Main solver optional output functions **Notes:** The user must allocate space for *eweight*, that will be filled in by this function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetErrWeights` instead. @@ -1852,7 +1852,7 @@ Main solver optional output functions .. versionadded:: 5.2.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodePrintAllStats` instead. @@ -1870,7 +1870,7 @@ Main solver optional output functions The return value is a string containing the name of the corresponding constant. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetReturnFlagName` instead. @@ -1913,7 +1913,7 @@ Main solver optional output functions * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumStepSolveFails` instead. @@ -1991,7 +1991,7 @@ Main solver optional output functions .. versionadded:: 5.3.0 - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetUserData` instead. @@ -2023,7 +2023,7 @@ Implicit solver optional output functions solver object; the counter is reset whenever a new nonlinear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinSolvSetups` instead. @@ -2050,7 +2050,7 @@ Implicit solver optional output functions solver object; the counter is reset whenever a new nonlinear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumNonlinSolvIters` instead. @@ -2077,7 +2077,7 @@ Implicit solver optional output functions solver object; the counter is reset whenever a new nonlinear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumNonlinSolvConvFails` instead. @@ -2107,7 +2107,7 @@ Implicit solver optional output functions nonlinear solver object; the counters are reset whenever a new nonlinear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNonlinSolvStats` instead. @@ -2144,7 +2144,7 @@ Rootfinding optional output functions zero-crossing. A value of +1 indicates that :math:`g_i` is increasing, while a value of -1 indicates a decreasing :math:`g_i`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetRootInfo` instead. @@ -2163,7 +2163,7 @@ Rootfinding optional output functions * *ARK_SUCCESS* if successful * *ARK_MEM_NULL* if the MRIStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumGEvals` instead. @@ -2191,7 +2191,7 @@ Linear solver interface optional output functions This function is provided for debugging purposes and the values in the returned matrix should not be altered. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetJac` instead. @@ -2208,7 +2208,7 @@ Linear solver interface optional output functions :retval ARKLS_MEM_NULL: ``arkode_mem`` was ``NULL`` :retval ARKLS_LMEM_NULL: the linear solver interface has not been initialized - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetJacTime` instead. @@ -2226,7 +2226,7 @@ Linear solver interface optional output functions :retval ARKLS_MEM_NULL: ``arkode_mem`` was ``NULL`` :retval ARKLS_LMEM_NULL: the linear solver interface has not been initialized - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetJacNumSteps` instead. @@ -2260,7 +2260,7 @@ Linear solver interface optional output functions In a parallel setting, the above values are global (i.e., summed over all processors). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLinWorkSpace` instead. @@ -2287,7 +2287,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumJacEvals` instead. @@ -2316,7 +2316,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumPrecEvals` instead. @@ -2344,7 +2344,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumPrecSolves` instead. @@ -2371,7 +2371,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinIters` instead. @@ -2398,7 +2398,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinConvFails` instead. @@ -2426,7 +2426,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumJTSetupEvals` instead. @@ -2454,7 +2454,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumJtimesEvals` instead. @@ -2487,7 +2487,7 @@ Linear solver interface optional output functions solver object; the counter is reset whenever a new linear solver module is "attached" to MRIStep, or when MRIStep is resized. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumLinRhsEvals` instead. @@ -2546,7 +2546,7 @@ Linear solver interface optional output functions *SUN_ERR_EXT_FAIL*, indicating an unrecoverable failure in an external iterative linear solver package. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastLinFlag` instead. @@ -2564,7 +2564,7 @@ Linear solver interface optional output functions ``SUNLINSOL_BAND`` modules, then if 1 :math:`\le` `lsflag` :math:`\le n` (LU factorization failed), this routine returns "NONE". - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLinReturnFlagName` instead. @@ -2599,7 +2599,7 @@ General usability functions for this pointer, since parameters for all processes would be identical. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWriteParameters` instead. @@ -2627,7 +2627,7 @@ General usability functions for this pointer, since tables for all processes would be identical. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`MRIStepGetCurrentCoupling` and :c:func:`MRIStepCoupling_Write` instead. @@ -2764,7 +2764,7 @@ MRIStep reset function (*tR*, *yR*) arguments for the :c:type:`MRIStepInnerStepper` object that is used to evolve the MRI "fast" time scale subproblems. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeReset` instead. @@ -2842,6 +2842,6 @@ MRIStep system resize function routine, see the supplied serial C example problem, ``ark_heat1D_adapt.c``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeResize` instead. diff --git a/doc/arkode/guide/source/Usage/Relaxation.rst b/doc/arkode/guide/source/Usage/Relaxation.rst index f69c60e392..a3b237ccbd 100644 --- a/doc/arkode/guide/source/Usage/Relaxation.rst +++ b/doc/arkode/guide/source/Usage/Relaxation.rst @@ -70,7 +70,7 @@ Enabling or Disabling Relaxation the step fails or applying relaxation fails, :c:func:`ARKodeEvolve` will return with an error. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 Optional Input Functions ------------------------ @@ -94,7 +94,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxLowerBound(void* arkode_mem, sunrealtype lower) @@ -116,7 +116,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxUpperBound(void* arkode_mem, sunrealtype upper) @@ -138,7 +138,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxMaxFails(void* arkode_mem, int max_fails) @@ -158,7 +158,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxMaxIters(void* arkode_mem, int max_iters) @@ -182,7 +182,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxSolver(void* arkode_mem, ARKRelaxSolver solver) @@ -201,7 +201,7 @@ relaxation. ``NULL`` :retval ARK_ILL_INPUT: an invalid solver option was provided - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxResTol(void* arkode_mem, sunrealtype res_tol) @@ -227,7 +227,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetRelaxTol(void* arkode_mem, sunrealtype rel_tol, sunrealtype abs_tol) @@ -254,7 +254,7 @@ relaxation. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 Optional Output Functions @@ -275,7 +275,7 @@ about the performance of the relaxation method. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumRelaxJacEvals(void* arkode_mem, long int* J_evals) @@ -290,7 +290,7 @@ about the performance of the relaxation method. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumRelaxFails(void* arkode_mem, long int* fails) @@ -310,7 +310,7 @@ about the performance of the relaxation method. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumRelaxBoundFails(void* arkode_mem, long int* fails) @@ -326,7 +326,7 @@ about the performance of the relaxation method. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumRelaxSolveFails(void* arkode_mem, long int* fails) @@ -341,7 +341,7 @@ about the performance of the relaxation method. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumRelaxSolveIters(void* arkode_mem, long int* iters) @@ -356,4 +356,4 @@ about the performance of the relaxation method. :retval ARK_RELAX_MEM_NULL: the internal relaxation memory structure was ``NULL`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 diff --git a/doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst b/doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst index ccf9617daa..d8f4dec8f9 100644 --- a/doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst +++ b/doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst @@ -70,7 +70,7 @@ SPRKStep initialization and deallocation functions :param arkode_mem: pointer to the SPRKStep memory block. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeFree` instead. @@ -104,7 +104,7 @@ Rootfinding initialization function :retval ARK_MEM_FAIL: if there was a memory allocation failure :retval ARK_ILL_INPUT: if *nrtfn* is greater than zero but *g* = ``NULL``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeRootInit` instead. @@ -199,7 +199,7 @@ SPRKStep solver function On all other error returns, *tret* and *yout* are left unchanged from those provided to the routine. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeEvolve` instead. @@ -237,14 +237,14 @@ Optional inputs for SPRKStep Also leaves alone any data structures or options related to root-finding (those can be reset using :c:func:`SPRKStepRootInit()`). - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetDefaults` instead. .. c:function:: int SPRKStepSetInterpolantType(void* arkode_mem, int itype) - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 This function is now a wrapper to :c:func:`ARKodeSetInterpolantType`, see the documentation for that function instead. @@ -284,7 +284,7 @@ Optional inputs for SPRKStep When `q = 1`, a linear interpolant is the default to ensure values obtained by the integrator are returned at the ends of the time interval. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetInterpolantDegree` instead. @@ -300,7 +300,7 @@ Optional inputs for SPRKStep :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` :retval ARK_ILL_INPUT: if an argument has an illegal value - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetFixedStep` instead. @@ -323,7 +323,7 @@ Optional inputs for SPRKStep :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` :retval ARK_ILL_INPUT: if an argument has an illegal value - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetMaxNumSteps` instead. @@ -350,7 +350,7 @@ Optional inputs for SPRKStep :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` :retval ARK_ILL_INPUT: if an argument has an illegal value - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetStopTime` instead. @@ -367,7 +367,7 @@ Optional inputs for SPRKStep :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeClearStopTime` instead. @@ -388,7 +388,7 @@ Optional inputs for SPRKStep :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` :retval ARK_ILL_INPUT: if an argument has an illegal value - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetUserData` instead. @@ -437,7 +437,7 @@ Optional inputs for IVP method selection This overrides any previously set method so it should not be used with :c:func:`SPRKStepSetMethod` or :c:func:`SPRKStepSetMethodName`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetOrder` instead. @@ -524,7 +524,7 @@ Rootfinding optional input functions :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` :retval ARK_ILL_INPUT: if an argument has an illegal value - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetRootDirection` instead. @@ -546,7 +546,7 @@ Rootfinding optional input functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory is ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeSetNoInactiveRootWarn` instead. @@ -596,7 +596,7 @@ Interpolated output function It is only legal to call this function after a successful return from :c:func:`SPRKStepEvolve()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetDky` instead. @@ -624,7 +624,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumSteps` instead. @@ -640,7 +640,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetLastStep` instead. @@ -655,7 +655,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentStep` instead. @@ -670,7 +670,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentTime` instead. @@ -691,7 +691,7 @@ Main solver optional output functions as altering values of *ycur* may lead to undesirable behavior, depending on the particular use case and on when this routine is called. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentState` instead. @@ -710,7 +710,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetStepStats` instead. @@ -737,7 +737,7 @@ Main solver optional output functions read and output the data from a SUNDIALS CSV output file using the key and value pair format. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodePrintAllStats` instead. @@ -752,7 +752,7 @@ Main solver optional output functions :returns: The return value is a string containing the name of the corresponding constant. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetReturnFlagName` instead. @@ -767,7 +767,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumStepAttempts` instead. @@ -808,7 +808,7 @@ Main solver optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the ARKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetUserData` instead. @@ -840,7 +840,7 @@ Rootfinding optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetRootInfo` instead. @@ -856,7 +856,7 @@ Rootfinding optional output functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNumGEvals` instead. @@ -882,7 +882,7 @@ General usability functions :retval ARK_SUCCESS: if successful :retval ARK_MEM_NULL: if the SPRKStep memory was ``NULL`` - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeWriteParameters` instead. @@ -975,6 +975,6 @@ SPRKStep reset function By default the next call to :c:func:`SPRKStepEvolve()` will use the step size computed by SPRKStep prior to calling :c:func:`SPRKStepReset()`. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeReset` instead. diff --git a/doc/arkode/guide/source/Usage/User_callable.rst b/doc/arkode/guide/source/Usage/User_callable.rst index 4f37c689ca..fd9261eaa3 100644 --- a/doc/arkode/guide/source/Usage/User_callable.rst +++ b/doc/arkode/guide/source/Usage/User_callable.rst @@ -67,7 +67,7 @@ For functions to create an ARKODE stepper instance see :c:func:`ARKStepCreate`, :param arkode_mem: pointer to the ARKODE stepper memory block. :return: none - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 This function replaces stepper specific versions in ARKStep, ERKStep, MRIStep, and SPRKStep. @@ -125,7 +125,7 @@ Alternatively, the user may supply a custom function to supply the :retval ARK_NO_MALLOC: ``arkode_mem`` was not allocated. :retval ARK_ILL_INPUT: an argument had an illegal value (e.g. a negative tolerance). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSVtolerances(void* arkode_mem, sunrealtype reltol, N_Vector abstol) @@ -144,7 +144,7 @@ Alternatively, the user may supply a custom function to supply the :retval ARK_NO_MALLOC: ``arkode_mem`` was not allocated. :retval ARK_ILL_INPUT: an argument had an illegal value (e.g. a negative tolerance). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeWFtolerances(void* arkode_mem, ARKEwtFn efun) @@ -160,7 +160,7 @@ Alternatively, the user may supply a custom function to supply the :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. :retval ARK_NO_MALLOC: ``arkode_mem`` was not allocated. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 Moreover, for problems involving a non-identity mass matrix @@ -214,7 +214,7 @@ these functions is provided below. :retval ARK_NO_MALLOC: ``arkode_mem`` was not allocated. :retval ARK_ILL_INPUT: an argument had an illegal value (e.g. a negative tolerance). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeResVtolerance(void* arkode_mem, N_Vector rabstol) @@ -230,7 +230,7 @@ these functions is provided below. :retval ARK_NO_MALLOC: ``arkode_mem`` was not allocated. :retval ARK_ILL_INPUT: an argument had an illegal value (e.g. a negative tolerance). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeResFtolerance(void* arkode_mem, ARKRwtFn rfun) @@ -246,7 +246,7 @@ these functions is provided below. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. :retval ARK_NO_MALLOC: ``arkode_mem`` was not allocated. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 General advice on the choice of tolerances @@ -480,7 +480,7 @@ pertinent to their choice of linear solver. insufficient to store :math:`\mathcal{A}` then it will need to be resized internally by ARKODE. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -596,7 +596,7 @@ Newton and mass matrix systems, these must have the same type: mass-matrix-times-vector product routine (see :c:type:`ARKLsMassTimesVecFn` and :c:func:`ARKodeSetMassTimes`). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -647,7 +647,7 @@ function attaches the nonlinear solver to the main ARKODE integrator. default; a call to this routine replaces that module with the supplied *NLS* object. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -697,7 +697,7 @@ called prior to a continuation call to :c:func:`ARKodeEvolve`. problem but the prior one did, then call *ARKodeRootInit* with *nrtfn = 0*. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -821,7 +821,7 @@ the user has set a stop time (with a call to the optional input function On all other error returns, *tret* and *yout* are left unchanged from those provided to the routine. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -912,7 +912,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr Also leaves alone any data structures or options related to root-finding (those can be reset using :c:func:`ARKodeRootInit`). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetOrder(void* arkode_mem, int ord) @@ -939,7 +939,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr ARKODE memory block, it cannot be changed after the first call to :c:func:`ARKodeEvolve`, unless ``*StepReInit`` is called. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetInterpolantType(void* arkode_mem, int itype) @@ -986,14 +986,14 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr :retval ARK_ILL_INPUT: the *itype* argument is not recognized or the interpolation module has already been initialized. - .. versionchanged:: x.y.z + .. versionchanged:: 6.1.0 Added the ``ARK_INTERP_NONE`` option to disable interpolation. Values set by a previous call to :c:func:`ARKStepSetInterpolantDegree` are no longer nullified by a call to :c:func:`ARKStepSetInterpolantType`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 This function replaces stepper specific versions in ARKStep, ERKStep, MRIStep, and SPRKStep. @@ -1035,7 +1035,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr obtained by the integrator are returned at the ends of the time interval. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetFixedStep(void* arkode_mem, sunrealtype hfixed) @@ -1091,7 +1091,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr routines will provide no useful information to the solver, and at worst they may interfere with the desired fixed step size. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -1119,7 +1119,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr This routine will also reset the step size and error history. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -1147,7 +1147,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr A negative value indicates that no warning messages should be issued. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -1171,7 +1171,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr Passing *mxsteps* < 0 disables the test (not recommended). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxStep(void* arkode_mem, sunrealtype hmax) @@ -1193,7 +1193,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr Pass *hmax* :math:`\le 0.0` to set the default value of :math:`\infty`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMinStep(void* arkode_mem, sunrealtype hmin) @@ -1215,7 +1215,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr Pass *hmin* :math:`\le 0.0` to set the default value of 0. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetStopTime(void* arkode_mem, sunrealtype tstop) @@ -1242,7 +1242,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr :c:func:`ARKodeReset` will remain active but can be disabled by calling :c:func:`ARKodeClearStopTime`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetInterpolateStopTime(void* arkode_mem, sunbooleantype interp) @@ -1257,7 +1257,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeClearStopTime(void* arkode_mem) @@ -1274,7 +1274,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr The stop time can be reenabled though a new call to :c:func:`ARKodeSetStopTime`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetUserData(void* arkode_mem, void* user_data) @@ -1299,7 +1299,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr this function must be made *before* any calls to :c:func:`ARKodeSetLinearSolver` and/or :c:func:`ARKodeSetMassLinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxErrTestFails(void* arkode_mem, int maxnef) @@ -1323,7 +1323,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr The default value is 7; set *maxnef* :math:`\le 0` to specify this default. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetConstraints(void* arkode_mem, N_Vector constraints) @@ -1371,7 +1371,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr and :c:func:`ARKodeSetFixedStep` are incompatible, and should not be used simultaneously. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxNumConstrFails(void* arkode_mem, int maxfails) @@ -1394,7 +1394,7 @@ Set max number of constraint failures :c:func:`ARKodeSetMaxNumConstr Passing *maxfails* <= 0 results in ARKODE using the default value (10). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -1448,7 +1448,7 @@ Explicit stability function :c:func:`ARKodeSetSt This is only compatible with time-stepping modules that support temporal adaptivity. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetAdaptivityAdjustment(void* arkode_mem, int adjust) @@ -1474,7 +1474,7 @@ Explicit stability function :c:func:`ARKodeSetSt This should be called prior to calling :c:func:`ARKodeEvolve`, and can only be reset following a call to ``*StepReInit``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetCFLFraction(void* arkode_mem, sunrealtype cfl_frac) @@ -1497,7 +1497,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any non-positive parameter will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetErrorBias(void* arkode_mem, sunrealtype bias) @@ -1525,7 +1525,7 @@ Explicit stability function :c:func:`ARKodeSetSt :c:func:`ARKodeSetAdaptController` will be called, then this routine must be called *second*. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetFixedStepBounds(void* arkode_mem, sunrealtype lb, sunrealtype ub) @@ -1548,7 +1548,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any interval *not* containing 1.0 will imply a reset to the default values. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxCFailGrowth(void* arkode_mem, sunrealtype etacf) @@ -1573,7 +1573,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value outside the interval :math:`(0,1]` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxEFailGrowth(void* arkode_mem, sunrealtype etamxf) @@ -1596,7 +1596,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value outside the interval :math:`(0,1]` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxFirstGrowth(void* arkode_mem, sunrealtype etamx1) @@ -1620,7 +1620,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value :math:`\le 1.0` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxGrowth(void* arkode_mem, sunrealtype mx_growth) @@ -1644,7 +1644,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value :math:`\le 1.0` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMinReduction(void* arkode_mem, sunrealtype eta_min) @@ -1670,7 +1670,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value outside the interval :math:`(0,1)` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetSafetyFactor(void* arkode_mem, sunrealtype safety) @@ -1694,7 +1694,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value :math:`\le 0` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetSmallNumEFails(void* arkode_mem, int small_nef) @@ -1718,7 +1718,7 @@ Explicit stability function :c:func:`ARKodeSetSt Any value :math:`\le 0` will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetStabilityFn(void* arkode_mem, ARKExpStabFn EStab, void* estab_data) @@ -1748,7 +1748,7 @@ Explicit stability function :c:func:`ARKodeSetSt be quite useful for problems where the explicit right-hand side function :math:`f^E(t,y)` contains stiff terms. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -1816,7 +1816,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS stage. Thus one must balance the relative costs of such recomputation against the benefits of requiring only a single Newton linear solve. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetNonlinear(void* arkode_mem) @@ -1841,7 +1841,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS :c:func:`ARKodeSetDeltaGammaMax` to reset the step size ratio threshold to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetAutonomous(void* arkode_mem, sunbooleantype autonomous) @@ -1893,7 +1893,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS evaluation but instead evaluate the necessary quantities within the preconditioner setup function using the input values. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetPredictorMethod(void* arkode_mem, int method) @@ -1928,7 +1928,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS The default value is 0. If *method* is set to an undefined value, this default predictor will be used. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetStagePredictFn(void* arkode_mem, ARKStagePredictFn PredictStage) @@ -1952,7 +1952,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS See :numref:`ARKODE.Usage.StagePredictFn` for more information on this user-supplied routine. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetNlsRhsFn(void* arkode_mem, ARKRhsFn nls_fi) @@ -1981,7 +1981,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS When using a non-default nonlinear solver, this function must be called *after* :c:func:`ARKodeSetNonlinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxNonlinIters(void* arkode_mem, int maxcor) @@ -2006,7 +2006,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS The default value is 3; set *maxcor* :math:`\le 0` to specify this default. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetNonlinConvCoef(void* arkode_mem, sunrealtype nlscoef) @@ -2030,7 +2030,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS The default value is 0.1; set *nlscoef* :math:`\le 0` to specify this default. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetNonlinCRDown(void* arkode_mem, sunrealtype crdown) @@ -2052,7 +2052,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS Any non-positive parameter will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetNonlinRDiv(void* arkode_mem, sunrealtype rdiv) @@ -2076,7 +2076,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS Any non-positive parameter will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMaxConvFails(void* arkode_mem, int maxncf) @@ -2108,7 +2108,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS convergence failure still occurs, the time step size is reduced by the factor *etacf* (set within :c:func:`ARKodeSetMaxCFailGrowth`). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetDeduceImplicitRhs(void *arkode_mem, sunbooleantype deduce) @@ -2131,7 +2131,7 @@ Specify if the implicit RHS is deduced after a nonlinear solve :c:func:`ARKodeS This is only compatible with time-stepping modules that support implicit algebraic solvers. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. _ARKODE.Usage.ARKLsInputs: @@ -2238,7 +2238,7 @@ is recomputed using the current :math:`\gamma` value. Any non-positive parameter will imply a reset to the default value. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. index:: single: optional input; linear solver setup frequency (ARKODE) @@ -2266,7 +2266,7 @@ is recomputed using the current :math:`\gamma` value. step. If **msbp** is 0, the default value of 20 will be used. A negative value forces a linear solver step at each implicit stage. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. index:: @@ -2308,7 +2308,7 @@ is recomputed using the current :math:`\gamma` value. This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`ARKodeSetLinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -2405,7 +2405,7 @@ data in the program. The user data pointer may be specified through The function type :c:func:`ARKLsJacFn` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetLinSysFn(void* arkode_mem, ARKLsLinSysFn linsys) @@ -2437,7 +2437,7 @@ data in the program. The user data pointer may be specified through The function type :c:func:`ARKLsLinSysFn` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMassFn(void* arkode_mem, ARKLsMassFn mass) @@ -2469,7 +2469,7 @@ data in the program. The user data pointer may be specified through The function type :c:func:`ARKLsMassFn` is described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetLinearSolutionScaling(void* arkode_mem, sunbooleantype onoff) @@ -2495,7 +2495,7 @@ data in the program. The user data pointer may be specified through Linear solution scaling is enabled by default when a matrix-based linear solver is attached. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. _ARKODE.Usage.ARKLsInputs.MatrixFree: @@ -2575,7 +2575,7 @@ time they are called. :c:type:`ARKLsJacTimesVecFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 When using the internal difference quotient the user may optionally supply @@ -2619,7 +2619,7 @@ this through calls to *both* :c:func:`ARKodeSetJacTimesRhsFn` and This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`ARKodeSetLinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 Similarly, if a problem involves a non-identity mass matrix, @@ -2676,7 +2676,7 @@ function of type :c:type:`ARKLsMassTimesSetupFn` (see :c:type:`ARKLsMassTimesVecFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -2765,7 +2765,7 @@ the user through the :c:func:`ARKodeSetEpsLin` function. :c:func:`ARKLsPrecSolveFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMassPreconditioner(void* arkode_mem, ARKLsMassPrecSetupFn psetup, ARKLsMassPrecSolveFn psolve) @@ -2802,7 +2802,7 @@ the user through the :c:func:`ARKodeSetEpsLin` function. :c:func:`ARKLsMassPrecSolveFn` are described in :numref:`ARKODE.Usage.UserSupplied`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetEpsLin(void* arkode_mem, sunrealtype eplifac) @@ -2832,7 +2832,7 @@ the user through the :c:func:`ARKodeSetEpsLin` function. interface has been initialized through a call to :c:func:`ARKodeSetLinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMassEpsLin(void* arkode_mem, sunrealtype eplifac) @@ -2862,7 +2862,7 @@ the user through the :c:func:`ARKodeSetEpsLin` function. Passing a value *eplifac* :math:`\le 0` indicates to use the default value of 0.05. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 Since iterative linear solver libraries typically consider linear residual @@ -2910,7 +2910,7 @@ allow for additional user control over these conversion factors. This function must be called *after* the ARKLS system solver interface has been initialized through a call to :c:func:`ARKodeSetLinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetMassLSNormFactor(void* arkode_mem, sunrealtype nrmfac) @@ -2943,7 +2943,7 @@ allow for additional user control over these conversion factors. This function must be called *after* the ARKLS mass matrix solver interface has been initialized through a call to :c:func:`ARKodeSetMassLinearSolver`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -2990,7 +2990,7 @@ Disable inactive root warnings :c:func:`ARKodeSetNoInactiveRootWarn` e The default behavior is to monitor for both zero-crossing directions. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeSetNoInactiveRootWarn(void* arkode_mem) @@ -3013,7 +3013,7 @@ Disable inactive root warnings :c:func:`ARKodeSetNoInactiveRootWarn` e first step), ARKODE will issue a warning which can be disabled with this optional input function. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -3073,7 +3073,7 @@ polynomial model may be evaluated upon request. functions :c:func:`ARKodeGetCurrentTime` and :c:func:`ARKodeGetLastStep`, respectively. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -3186,7 +3186,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumSteps(void* arkode_mem, long int* nsteps) @@ -3200,7 +3200,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetActualInitStep(void* arkode_mem, sunrealtype* hinused) @@ -3223,7 +3223,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat local error test condition, or to ensure convergence of the nonlinear solver. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetLastStep(void* arkode_mem, sunrealtype* hlast) @@ -3237,7 +3237,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetCurrentStep(void* arkode_mem, sunrealtype* hcur) @@ -3250,7 +3250,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetCurrentTime(void* arkode_mem, sunrealtype* tcur) @@ -3263,7 +3263,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetCurrentState(void *arkode_mem, N_Vector *ycur) @@ -3282,7 +3282,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat as altering values of *ycur* may lead to undesirable behavior, depending on the particular use case and on when this routine is called. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetCurrentGamma(void *arkode_mem, sunrealtype *gamma) @@ -3302,7 +3302,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat This is only compatible with time-stepping modules that support implicit algebraic solvers. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetTolScaleFactor(void* arkode_mem, sunrealtype* tolsfac) @@ -3317,7 +3317,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetErrWeights(void* arkode_mem, N_Vector eweight) @@ -3335,7 +3335,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat The user must allocate space for *eweight*, that will be filled in by this function. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetResWeights(void* arkode_mem, N_Vector rweight) @@ -3357,7 +3357,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat The user must allocate space for *rweight*, that will be filled in by this function. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetStepStats(void* arkode_mem, long int* nsteps, sunrealtype* hinused, sunrealtype* hlast, sunrealtype* hcur, sunrealtype* tcur) @@ -3374,7 +3374,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodePrintAllStats(void* arkode_mem, FILE* outfile, SUNOutputFormat fmt) @@ -3401,7 +3401,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat read and output the data from a SUNDIALS CSV output file using the key and value pair format. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: char* ARKodeGetReturnFlagName(long int flag) @@ -3414,7 +3414,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :return: The return value is a string containing the name of the corresponding constant. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumExpSteps(void* arkode_mem, long int* expsteps) @@ -3434,7 +3434,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat This is only compatible with time-stepping modules that support temporal adaptivity. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumAccSteps(void* arkode_mem, long int* accsteps) @@ -3454,7 +3454,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat This is only compatible with time-stepping modules that support temporal adaptivity. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumStepAttempts(void* arkode_mem, long int* step_attempts) @@ -3467,7 +3467,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumErrTestFails(void* arkode_mem, long int* netfails) @@ -3485,7 +3485,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat This is only compatible with time-stepping modules that support temporal adaptivity. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumStepSolveFails(void* arkode_mem, long int* ncnf) @@ -3504,7 +3504,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat This is only compatible with time-stepping modules that support implicit algebraic solvers. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetEstLocalErrors(void* arkode_mem, N_Vector ele) @@ -3535,7 +3535,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat failures, the components causing the failures are those with largest values for the products, denoted loosely as ``eweight[i]*ele[i]``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumConstrFails(void* arkode_mem, long int* nconstrfails) @@ -3554,7 +3554,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat This is only compatible with time-stepping modules that support temporal adaptivity. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetUserData(void* arkode_mem, void** user_data) @@ -3568,7 +3568,7 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. _ARKODE.Usage.ARKodeImplicitSolverOutputs: @@ -3614,7 +3614,7 @@ Single accessor to all nonlinear solver statistics :c:func:`ARKodeGetNonlinSol solver object; the counter is reset whenever a new nonlinear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumNonlinSolvIters(void* arkode_mem, long int* nniters) @@ -3639,7 +3639,7 @@ Single accessor to all nonlinear solver statistics :c:func:`ARKodeGetNonlinSol solver object; the counter is reset whenever a new nonlinear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumNonlinSolvConvFails(void* arkode_mem, long int* nncfails) @@ -3663,7 +3663,7 @@ Single accessor to all nonlinear solver statistics :c:func:`ARKodeGetNonlinSol solver object; the counter is reset whenever a new nonlinear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNonlinSolvStats(void* arkode_mem, long int* nniters, long int* nncfails) @@ -3688,7 +3688,7 @@ Single accessor to all nonlinear solver statistics :c:func:`ARKodeGetNonlinSol solver object; the counters are reset whenever a new nonlinear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. _ARKODE.Usage.ARKodeRootOutputs: @@ -3733,7 +3733,7 @@ No. of calls to user root function :c:func:`ARKodeGetNumGEvals zero-crossing. A value of +1 indicates that :math:`g_i` is increasing, while a value of -1 indicates a decreasing :math:`g_i`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumGEvals(void* arkode_mem, long int* ngevals) @@ -3747,7 +3747,7 @@ No. of calls to user root function :c:func:`ARKodeGetNumGEvals :retval ARK_SUCCESS: the function exited successfully. :retval ARK_MEM_NULL: ``arkode_mem`` was ``NULL``. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -3820,7 +3820,7 @@ Last return from a mass matrix solver function :c:func:`ARKo This function is provided for debugging purposes and the values in the returned matrix should not be altered. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetJacTime(void* arkode_mem, sunrealtype* t_J) @@ -3860,7 +3860,7 @@ Last return from a mass matrix solver function :c:func:`ARKo This is only compatible with time-stepping modules that support implicit algebraic solvers. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetLinWorkSpace(void* arkode_mem, long int* lenrwLS, long int* leniwLS) @@ -3890,7 +3890,7 @@ Last return from a mass matrix solver function :c:func:`ARKo In a parallel setting, the above values are global (i.e. summed over all processors). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumJacEvals(void* arkode_mem, long int* njevals) @@ -3914,7 +3914,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumPrecEvals(void* arkode_mem, long int* npevals) @@ -3940,7 +3940,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumPrecSolves(void* arkode_mem, long int* npsolves) @@ -3965,7 +3965,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumLinIters(void* arkode_mem, long int* nliters) @@ -3989,7 +3989,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumLinConvFails(void* arkode_mem, long int* nlcfails) @@ -4013,7 +4013,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumJTSetupEvals(void* arkode_mem, long int* njtsetup) @@ -4038,7 +4038,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumJtimesEvals(void* arkode_mem, long int* njvevals) @@ -4063,7 +4063,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumLinRhsEvals(void* arkode_mem, long int* nfevalsLS) @@ -4093,7 +4093,7 @@ Last return from a mass matrix solver function :c:func:`ARKo solver object; the counter is reset whenever a new linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetLastLinFlag(void* arkode_mem, long int* lsflag) @@ -4149,7 +4149,7 @@ Last return from a mass matrix solver function :c:func:`ARKo *SUN_ERR_EXT_FAIL*, indicating an unrecoverable failure in an external iterative linear solver package. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: char* ARKodeGetLinReturnFlagName(long int lsflag) @@ -4168,7 +4168,7 @@ Last return from a mass matrix solver function :c:func:`ARKo This is only compatible with time-stepping modules that support implicit algebraic solvers. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetMassWorkSpace(void* arkode_mem, long int* lenrwMLS, long int* leniwMLS) @@ -4198,7 +4198,7 @@ Last return from a mass matrix solver function :c:func:`ARKo In a parallel setting, the above values are global (i.e. summed over all processors). - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassSetups(void* arkode_mem, long int* nmsetups) @@ -4225,7 +4225,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassMultSetups(void* arkode_mem, long int* nmvsetups) @@ -4251,7 +4251,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassMult(void* arkode_mem, long int* nmmults) @@ -4278,7 +4278,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassSolves(void* arkode_mem, long int* nmsolves) @@ -4303,7 +4303,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassPrecEvals(void* arkode_mem, long int* nmpevals) @@ -4329,7 +4329,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassPrecSolves(void* arkode_mem, long int* nmpsolves) @@ -4355,7 +4355,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassIters(void* arkode_mem, long int* nmiters) @@ -4380,7 +4380,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMassConvFails(void* arkode_mem, long int* nmcfails) @@ -4405,7 +4405,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetNumMTSetups(void* arkode_mem, long int* nmtsetup) @@ -4431,7 +4431,7 @@ Last return from a mass matrix solver function :c:func:`ARKo linear solver module is "attached" to ARKODE, or when ARKODE is resized. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 .. c:function:: int ARKodeGetLastMassFlag(void* arkode_mem, long int* mlsflag) @@ -4456,7 +4456,7 @@ Last return from a mass matrix solver function :c:func:`ARKo will match those described above for the function :c:func:`ARKodeGetLastLinFlag`. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -4502,7 +4502,7 @@ Output all ARKODE solver parameters :c:func:`ARKodeWriteParameters` for this pointer, since parameters for all processes would be identical. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -4576,7 +4576,7 @@ vector. If an error occurred, :c:func:`ARKodeReset` also sends an error message to the error handler function. - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 @@ -4684,4 +4684,4 @@ rescale the upcoming time step by the specified factor. If a value * ``examples/arkode/C_serial/ark_heat1D_adapt.c`` - .. versionadded:: x.y.z + .. versionadded:: 6.1.0 diff --git a/doc/arkode/guide/source/sunnonlinsol/ARKODE_interface.rst b/doc/arkode/guide/source/sunnonlinsol/ARKODE_interface.rst index fe7f768419..92046f510c 100644 --- a/doc/arkode/guide/source/sunnonlinsol/ARKODE_interface.rst +++ b/doc/arkode/guide/source/sunnonlinsol/ARKODE_interface.rst @@ -226,7 +226,7 @@ of user-supplied SUNNonlinSol modules are as follows. * ``ARK_SUCCESS`` if successful. * ``ARK_MEM_NULL`` if the ARKStep memory was ``NULL``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetCurrentMassMatrix` instead. @@ -290,7 +290,7 @@ of user-supplied SUNNonlinSol modules are as follows. *Fi* are only current when :c:func:`ARKStepGetNonlinearSystemData()` is called after an evaluation of the nonlinear system function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNonlinearSystemData` instead. @@ -310,7 +310,7 @@ of user-supplied SUNNonlinSol modules are as follows. * ``ARK_SUCCESS`` if successful. * ``ARK_MEM_NULL`` if the ARKStep memory was ``NULL``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeComputeState` instead. @@ -393,7 +393,7 @@ of user-supplied SUNNonlinSol modules are as follows. *Fi* are only current when :c:func:`MRIStepGetNonlinearSystemData()` is called after an evaluation of the nonlinear system function. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeGetNonlinearSystemData` instead. @@ -413,6 +413,6 @@ of user-supplied SUNNonlinSol modules are as follows. * ``ARK_SUCCESS`` if successful. * ``ARK_MEM_NULL`` if the MRIStep memory was ``NULL``. - .. deprecated:: x.y.z + .. deprecated:: 6.1.0 Use :c:func:`ARKodeComputeState` instead. diff --git a/doc/cvode/guide/source/Introduction.rst b/doc/cvode/guide/source/Introduction.rst index c0025d1f07..651efba809 100644 --- a/doc/cvode/guide/source/Introduction.rst +++ b/doc/cvode/guide/source/Introduction.rst @@ -108,7 +108,7 @@ implementations. .. efficiency of C, and the greater ease of interfacing the solver to .. applications written in extended Fortran. -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 7.1.0 ==================================== .. include:: ../../../shared/RecentChanges.rst diff --git a/doc/cvodes/guide/source/Introduction.rst b/doc/cvodes/guide/source/Introduction.rst index 55ea22f2cd..fbf0685067 100644 --- a/doc/cvodes/guide/source/Introduction.rst +++ b/doc/cvodes/guide/source/Introduction.rst @@ -109,7 +109,7 @@ greater ease of interfacing the solver to applications written in extended Fortran. -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 7.1.0 ==================================== .. include:: ../../../shared/RecentChanges.rst diff --git a/doc/ida/guide/source/Introduction.rst b/doc/ida/guide/source/Introduction.rst index 19dfc9a9d3..029b9a3523 100644 --- a/doc/ida/guide/source/Introduction.rst +++ b/doc/ida/guide/source/Introduction.rst @@ -69,7 +69,7 @@ systems. the greater ease of interfacing the solver to applications written in extended Fortran. -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 7.1.0 ==================================== .. include:: ../../../shared/RecentChanges.rst diff --git a/doc/idas/guide/source/Introduction.rst b/doc/idas/guide/source/Introduction.rst index a67642229c..771da6ec5b 100644 --- a/doc/idas/guide/source/Introduction.rst +++ b/doc/idas/guide/source/Introduction.rst @@ -83,7 +83,7 @@ integrate any final-condition ODE dependent on the solution of the original IVP the greater ease of interfacing the solver to applications written in extended Fortran. -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 6.1.0 ==================================== .. include:: ../../../shared/RecentChanges.rst diff --git a/doc/kinsol/guide/source/Introduction.rst b/doc/kinsol/guide/source/Introduction.rst index 6961e9da38..5dd8e82594 100644 --- a/doc/kinsol/guide/source/Introduction.rst +++ b/doc/kinsol/guide/source/Introduction.rst @@ -85,7 +85,7 @@ applications written in Fortran. .. _KINSOL.Introduction.Changes: -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 7.1.0 ==================================== .. include:: ../../../shared/RecentChanges.rst diff --git a/doc/shared/Changelog.rst b/doc/shared/Changelog.rst index 136e910f4a..4fa304b8ac 100644 --- a/doc/shared/Changelog.rst +++ b/doc/shared/Changelog.rst @@ -21,7 +21,7 @@ Changelog .. SED_REPLACEMENT_KEY -Changes to SUNDIALS in release X.Y.Z +Changes to SUNDIALS in release 7.1.0 ==================================== .. include:: RecentChanges_link.rst diff --git a/doc/shared/History.rst b/doc/shared/History.rst index cfdee0c931..b5c79886e3 100644 --- a/doc/shared/History.rst +++ b/doc/shared/History.rst @@ -21,6 +21,8 @@ Release History +----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+ | Date | SUNDIALS | ARKODE | CVODE | CVODES | IDA | IDAS | KINSOL | +==========+===================+===================+===================+===================+===================+===================+===================+ +| Jun 2024 | 7.1.0 | 6.1.0 | 7.1.0 | 7.1.0 | 7.1.0 | 6.1.0 | 7.1.0 | ++----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+ | Feb 2024 | 7.0.0 | 6.0.0 | 7.0.0 | 7.0.0 | 7.0.0 | 6.0.0 | 7.0.0 | +----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+ | Dec 2023 | 6.7.0 | 5.7.0 | 6.7.0 | 6.7.0 | 6.7.0 | 5.7.0 | 6.7.0 | diff --git a/doc/shared/sundials.bib b/doc/shared/sundials.bib index b4b5cf0343..afa6de0c0d 100644 --- a/doc/shared/sundials.bib +++ b/doc/shared/sundials.bib @@ -27,7 +27,7 @@ % @techreport{arkode_ug, author = {Daniel R. Reynolds and David J. Gardner and Carol S. Woodward and Rujeko Chinomona and Cody J. Balos}, -title = {{User Documentation for ARKODE v6.0.0}}, +title = {{User Documentation for ARKODE v6.1.0}}, institution = {LLNL}, number = {LLNL-SM-668082}, year = 2024 @@ -37,7 +37,7 @@ @techreport{arkode_ug % @techreport{arkode_ex, author = {Daniel R. Reynolds}, -title = {{Example Programs for ARKODE v6.0.0}}, +title = {{Example Programs for ARKODE v6.1.0}}, institution = {Southern Methodist University}, year = 2024 } @@ -46,7 +46,7 @@ @techreport{arkode_ex % @techreport{cvode_ug, author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, -title = {{User Documentation for CVODE v7.0.0}}, +title = {{User Documentation for CVODE v7.1.0}}, institution = {LLNL}, number = {UCRL-SM-208108}, year = 2024 @@ -56,7 +56,7 @@ @techreport{cvode_ug % @techreport{cvode_ex, author = {Alan C. Hindmarsh and Radu Serban}, -title = {{Example Programs for CVODE v7.0.0}}, +title = {{Example Programs for CVODE v7.1.0}}, institution = {LLNL}, note = {UCRL-SM-208110}, year = 2024 @@ -66,7 +66,7 @@ @techreport{cvode_ex % @techreport{cvodes_ug, author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, -title = {{User Documentation for CVODES v7.0.0}}, +title = {{User Documentation for CVODES v7.1.0}}, institution = {LLNL}, note = {UCRL-SM-208111}, year = 2024 @@ -76,7 +76,7 @@ @techreport{cvodes_ug % @techreport{cvodes_ex, author = {Radu Serban and Alan C. Hindmarsh}, -title = {{Example Programs for CVODES v7.0.0}}, +title = {{Example Programs for CVODES v7.1.0}}, institution = {LLNL}, number = {UCRL-SM-208115}, year = 2024 @@ -86,7 +86,7 @@ @techreport{cvodes_ex % @techreport{ida_ug, author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, -title = {{User Documentation for IDA v7.0.0}}, +title = {{User Documentation for IDA v7.1.0}}, institution = {LLNL}, number = {UCRL-SM-208112}, year = 2024 @@ -96,7 +96,7 @@ @techreport{ida_ug % @techreport{ida_ex, author = {Alan C. Hindmarsh and Radu Serban and Aaron Collier}, -title = {{Example Programs for IDA v7.0.0}}, +title = {{Example Programs for IDA v7.1.0}}, institution = {LLNL}, number = {UCRL-SM-208113}, year = 2024 @@ -106,7 +106,7 @@ @techreport{ida_ex % @techreport{idas_ug, author = {Radu Serban and Cosmin Petra and Alan C. Hindmarsh and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, -title = {{User Documentation for IDAS v6.0.0}}, +title = {{User Documentation for IDAS v6.1.0}}, institution = {LLNL}, number = {UCRL-SM-234051}, year = 2024 @@ -116,7 +116,7 @@ @techreport{idas_ug % @techreport{idas_ex, author = {Radu Serban and Alan C. Hindmarsh}, -title = {{Example Programs for IDAS v6.0.0}}, +title = {{Example Programs for IDAS v6.1.0}}, institution = {LLNL}, number = {LLNL-TR-437091}, year = 2024 @@ -126,7 +126,7 @@ @techreport{idas_ex % @techreport{kinsol_ug, author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward}, -title = {{User Documentation for KINSOL v7.0.0}}, +title = {{User Documentation for KINSOL v7.1.0}}, institution = {LLNL}, number = {UCRL-SM-208116}, year = 2024 @@ -136,7 +136,7 @@ @techreport{kinsol_ug % @techreport{kinsol_ex, author = {Aaron M. Collier and Radu Serban}, -title = {{Example Programs for KINSOL v7.0.0}}, +title = {{Example Programs for KINSOL v7.1.0}}, institution = {LLNL}, number = {UCRL-SM-208114}, year = 2024 diff --git a/doc/shared/sundials/Fortran.rst b/doc/shared/sundials/Fortran.rst index fbb6fdc0c4..97a5b80ba8 100644 --- a/doc/shared/sundials/Fortran.rst +++ b/doc/shared/sundials/Fortran.rst @@ -164,7 +164,7 @@ equivalencies with the parameter direction in mind. Currently, the Fortran 2003 interfaces are only compatible with SUNDIALS builds where the ``sunrealtype`` is double-precision. -.. versionchanged:: x.y.z +.. versionchanged:: 7.1.0 The Fortran interfaces can now be built with 32-bit ``sunindextype`` in addition to 64-bit ``sunindextype``. diff --git a/doc/shared/sundials/Install.rst b/doc/shared/sundials/Install.rst index bf63423eb5..d666fc7b29 100644 --- a/doc/shared/sundials/Install.rst +++ b/doc/shared/sundials/Install.rst @@ -33,17 +33,17 @@ SUNDIALS release compressed archives (``.tar.gz``) from the SUNDIALS The compressed archives allow for downloading of indvidual SUNDIALS packages. The name of the distribution archive is of the form -``SOLVER-X.Y.Z.tar.gz``, where ``SOLVER`` is one of: ``sundials``, ``cvode``, -``cvodes``, ``arkode``, ``ida``, ``idas``, or ``kinsol``, and ``X.Y.Z`` +``SOLVER-7.1.0.tar.gz``, where ``SOLVER`` is one of: ``sundials``, ``cvode``, +``cvodes``, ``arkode``, ``ida``, ``idas``, or ``kinsol``, and ``7.1.0`` represents the version number (of the SUNDIALS suite or of the individual solver). After downloading the relevant archives, uncompress and expand the sources, by running .. code-block:: bash - % tar -zxf SOLVER-X.Y.Z.tar.gz + % tar -zxf SOLVER-7.1.0.tar.gz -This will extract source files under a directory ``SOLVER-X.Y.Z``. +This will extract source files under a directory ``SOLVER-7.1.0``. Starting with version 2.6.0 of SUNDIALS, CMake is the only supported method of installation. The explanations of the installation procedure begin with a few @@ -51,7 +51,7 @@ common observations: #. The remainder of this chapter will follow these conventions: - ``SOLVERDIR`` is the directory ``SOLVER-X.Y.Z`` created above; i.e. the + ``SOLVERDIR`` is the directory ``SOLVER-7.1.0`` created above; i.e. the directory containing the SUNDIALS sources. ``BUILDDIR`` is the (temporary) directory under which SUNDIALS is built. @@ -674,7 +674,7 @@ illustration only. Default: "REF;OMP" - .. versionchanged: x.y.z + .. versionchanged: 7.1.0 The ``DPCPP`` option was changed to ``SYCL`` to align with Ginkgo's naming convention. @@ -1790,7 +1790,7 @@ configuration file to build against SUNDIALS in their own CMake project. .. note:: - .. versionchanged:: x.y.z + .. versionchanged:: 7.1.0 A single version provided to ``find_package`` denotes the minimum version of SUNDIALS to look for, and any version equal or newer than what is diff --git a/doc/shared/sundials_vars.py b/doc/shared/sundials_vars.py index b72f632920..dca40a56f2 100644 --- a/doc/shared/sundials_vars.py +++ b/doc/shared/sundials_vars.py @@ -9,14 +9,14 @@ # SPDX-License-Identifier: BSD-3-Clause # SUNDIALS Copyright End # ---------------------------------------------------------------- -doc_version = 'develop' -sundials_version = 'v7.0.0' -arkode_version = 'v6.0.0' -cvode_version = 'v7.0.0' -cvodes_version = 'v7.0.0' -ida_version = 'v7.0.0' -idas_version = 'v6.0.0' -kinsol_version = 'v7.0.0' +doc_version = 'v7.1.0' +sundials_version = 'v7.1.0' +arkode_version = 'v6.1.0' +cvode_version = 'v7.1.0' +cvodes_version = 'v7.1.0' +ida_version = 'v7.1.0' +idas_version = 'v6.1.0' +kinsol_version = 'v7.1.0' year = '2024' # Warn about all references where the target cannot be found diff --git a/doc/sundials/biblio.bib b/doc/sundials/biblio.bib index ad0b7f6bec..b0470d62e6 100644 --- a/doc/sundials/biblio.bib +++ b/doc/sundials/biblio.bib @@ -16,7 +16,7 @@ @techreport{arkode_ug, author={Daniel R. Reynolds and David J. Gardner and Alan C. Hindmarsh and Carol S. Woodward and Jean M. Sexton}, -title={{User Documentation for ARKODE v6.0.0}}, +title={{User Documentation for ARKODE v6.1.0}}, institution={LLNL}, number={LLNL-SM-668082}, year = 2024 @@ -26,7 +26,7 @@ @techreport{arkode_ug % @techreport{arkode_ex, author={Daniel R. Reynolds}, -title={{Example Programs for ARKODE v6.0.0}}, +title={{Example Programs for ARKODE v6.1.0}}, institution={Southern Methodist University}, year = 2024 } @@ -35,7 +35,7 @@ @techreport{arkode_ex % @techreport{cvode_ug, author={A. C. Hindmarsh and R. Serban}, -title={{User Documentation for CVODE v7.0.0}}, +title={{User Documentation for CVODE v7.1.0}}, institution={LLNL}, number={UCRL-SM-208108}, year = 2024 @@ -45,7 +45,7 @@ @techreport{cvode_ug % @techreport{cvode_ex, author={A. C. Hindmarsh and R. Serban and D. R. Reynolds}, -title={{Example Programs for CVODE v7.0.0}}, +title={{Example Programs for CVODE v7.1.0}}, institution={LLNL}, note={UCRL-SM-208110}, year = 2024 @@ -55,7 +55,7 @@ @techreport{cvode_ex % @techreport{cvodes_ug, author={A. C. Hindmarsh and R. Serban}, -title={{User Documentation for CVODES v7.0.0}}, +title={{User Documentation for CVODES v7.1.0}}, institution={LLNL}, note={UCRL-SM-208111}, year = 2024 @@ -65,7 +65,7 @@ @techreport{cvodes_ug % @techreport{cvodes_ex, author={R. Serban and A. C. Hindmarsh}, -title={{Example Programs for CVODES v7.0.0}}, +title={{Example Programs for CVODES v7.1.0}}, institution={LLNL}, number={UCRL-SM-208115}, year = 2024 @@ -75,7 +75,7 @@ @techreport{cvodes_ex % @techreport{ida_ug, author={A. C. Hindmarsh and R. Serban and A. Collier}, -title={{User Documentation for IDA v7.0.0}}, +title={{User Documentation for IDA v7.1.0}}, institution={LLNL}, number={UCRL-SM-208112}, year = 2024 @@ -85,7 +85,7 @@ @techreport{ida_ug % @techreport{ida_ex, author={A. C. Hindmarsh and R. Serban and A. Collier}, -title={{Example Programs for IDA v7.0.0}}, +title={{Example Programs for IDA v7.1.0}}, institution={LLNL}, number={UCRL-SM-208113}, year = 2024 @@ -95,7 +95,7 @@ @techreport{ida_ex % @techreport{idas_ug, author={R. Serban and C. Petra and A. C. Hindmarsh}, -title={{User Documentation for IDAS v6.0.0}}, +title={{User Documentation for IDAS v6.1.0}}, institution={LLNL}, number={UCRL-SM-234051}, year = 2024 @@ -105,7 +105,7 @@ @techreport{idas_ug % @techreport{idas_ex, author={R. Serban and A. C. Hindmarsh}, -title={{Example Programs for IDAS v6.0.0}}, +title={{Example Programs for IDAS v6.1.0}}, institution={LLNL}, number={LLNL-TR-437091}, year = 2024 @@ -115,7 +115,7 @@ @techreport{idas_ex % @techreport{kinsol_ug, author={A. M. Collier and A. C. Hindmarsh and R. Serban and C.S. Woodward}, -title={{User Documentation for KINSOL v7.0.0}}, +title={{User Documentation for KINSOL v7.1.0}}, institution={LLNL}, number={UCRL-SM-208116}, year = 2024 @@ -125,7 +125,7 @@ @techreport{kinsol_ug % @techreport{kinsol_ex, author={A. M. Collier and R. Serban}, -title={{Example Programs for KINSOL v7.0.0}}, +title={{Example Programs for KINSOL v7.1.0}}, institution={LLNL}, number={UCRL-SM-208114}, year = 2024 diff --git a/doc/sundials/ug.tex b/doc/sundials/ug.tex index 26724bb6ab..721acd879d 100644 --- a/doc/sundials/ug.tex +++ b/doc/sundials/ug.tex @@ -59,29 +59,29 @@ %----- VERSIONS AND UCRL NUMBERS OF SUNDIALS CODES -\newcommand{\sunrelease}{v7.0.0} +\newcommand{\sunrelease}{v7.1.0} -\newcommand{\cvrelease}{v7.0.0} +\newcommand{\cvrelease}{v7.1.0} \newcommand{\cvucrlug}{UCRL-SM-208108} \newcommand{\cvucrlex}{UCRL-SM-208110} -\newcommand{\cvsrelease}{v7.0.0} +\newcommand{\cvsrelease}{v7.1.0} \newcommand{\cvsucrlug}{UCRL-SM-208111} \newcommand{\cvsucrlex}{UCRL-SM-208115} -\newcommand{\idarelease}{v7.0.0} +\newcommand{\idarelease}{v7.1.0} \newcommand{\idaucrlug}{UCRL-SM-208112} \newcommand{\idaucrlex}{UCRL-SM-208113} -\newcommand{\idasrelease}{v6.0.0} +\newcommand{\idasrelease}{v6.1.0} \newcommand{\idasucrlug}{UCRL-SM-234051} \newcommand{\idasucrlex}{LLNL-TR-437091} -\newcommand{\kinrelease}{v7.0.0} +\newcommand{\kinrelease}{v7.1.0} \newcommand{\kinucrlug}{UCRL-SM-208116} \newcommand{\kinucrlex}{UCRL-SM-208114} -\newcommand{\arkrelease}{v6.0.0} +\newcommand{\arkrelease}{v6.1.0} \newcommand{\arkucrlug}{LLNL-SM-668082} \newcommand{\arkucrlex}{????-??-??????} diff --git a/scripts/tarscript b/scripts/tarscript index 8b64d9dd16..642dec13aa 100755 --- a/scripts/tarscript +++ b/scripts/tarscript @@ -57,13 +57,13 @@ function print_usage # VERSION NUMBERS #--------------------------------------------------------- -SUN_VER="7.0.0" -CV_VER="7.0.0" -CVS_VER="7.0.0" -IDA_VER="7.0.0" -IDAS_VER="6.0.0" -KIN_VER="7.0.0" -ARK_VER="6.0.0" +SUN_VER="7.1.0" +CV_VER="7.1.0" +CVS_VER="7.1.0" +IDA_VER="7.1.0" +IDAS_VER="6.1.0" +KIN_VER="7.1.0" +ARK_VER="6.1.0" #--------------------------------------------------------- # Test if the script is executed from within its directory diff --git a/scripts/updateVersion.sh b/scripts/updateVersion.sh index 30cc9b9147..e91e846bde 100755 --- a/scripts/updateVersion.sh +++ b/scripts/updateVersion.sh @@ -19,7 +19,7 @@ # development releases the label string is of the form "-dev.#" and for full # releases the label string is "". sun_major=${1:-7} -sun_minor=${2:-0} +sun_minor=${2:-1} sun_patch=${3:-0} sun_label=${4:-""} month=${5:-$(date +"%b")} diff --git a/src/arkode/README.md b/src/arkode/README.md index fd825b9dbb..d71f6b43ef 100644 --- a/src/arkode/README.md +++ b/src/arkode/README.md @@ -1,5 +1,5 @@ # ARKODE -### Version 6.0.0 (Feb 2024) +### Version 6.1.0 (Jun 2024) **Daniel R. Reynolds, Department of Mathematics, SMU** @@ -44,8 +44,8 @@ the "SUNDIALS Release History" appendix of the ARKODE User Guide. ## References * D. R. Reynolds, D. J. Gardner, C. S. Woodward, and C. J. Balos, - "User Documentation for ARKODE v6.0.0," LLNL technical report - LLNL-SM-668082, Feb 2024. + "User Documentation for ARKODE v6.1.0," LLNL technical report + LLNL-SM-668082, Jun 2024. -* D. R. Reynolds, "Example Programs for ARKODE v6.0.0," Technical Report, - Southern Methodist University Center for Scientific Computation, Feb 2024. +* D. R. Reynolds, "Example Programs for ARKODE v6.1.0," Technical Report, + Southern Methodist University Center for Scientific Computation, Jun 2024. diff --git a/src/cvode/README.md b/src/cvode/README.md index fbc0a5e9d4..7e17d2a68c 100644 --- a/src/cvode/README.md +++ b/src/cvode/README.md @@ -1,5 +1,5 @@ # CVODE -### Version 7.0.0 (Feb 2024) +### Version 7.1.0 (Jun 2024) **Alan C. Hindmarsh, Radu Serban, Cody J. Balos, David J. Gardner, and Carol S. Woodward, Center for Applied Scientific Computing, LLNL** @@ -47,11 +47,11 @@ the "SUNDIALS Release History" appendix of the CVODE User Guide. ## References * A. C. Hindmarsh, R. Serban, C. J. Balos, D. J. Gardner, D. R. Reynolds - and C. S. Woodward, "User Documentation for CVODE v7.0.0," - LLNL technical report UCRL-SM-208108, Feb 2024. + and C. S. Woodward, "User Documentation for CVODE v7.1.0," + LLNL technical report UCRL-SM-208108, Jun 2024. -* A. C. Hindmarsh and R. Serban, "Example Programs for CVODE v7.0.0," - LLNL technical report UCRL-SM-208110, Feb 2024. +* A. C. Hindmarsh and R. Serban, "Example Programs for CVODE v7.1.0," + LLNL technical report UCRL-SM-208110, Jun 2024. * S.D. Cohen and A.C. Hindmarsh, "CVODE, a Stiff/nonstiff ODE Solver in C," Computers in Physics, 10(2), pp. 138-143, 1996. diff --git a/src/cvodes/README.md b/src/cvodes/README.md index a5cf70488b..8e4259efdd 100644 --- a/src/cvodes/README.md +++ b/src/cvodes/README.md @@ -1,5 +1,5 @@ # CVODES -### Version 7.0.0 (Feb 2024) +### Version 7.1.0 (Jun 2024) **Alan C. Hindmarsh, Radu Serban, Cody J. Balos, David J. Gardner, and Carol S. Woodward, Center for Applied Scientific Computing, LLNL** @@ -44,11 +44,11 @@ the "SUNDIALS Release History" appendix of the CVODES User Guide. ## References * A. C. Hindmarsh, R. Serban, C. J. Balos, D. J. Gardner, D. R. Reynolds - and C. S. Woodward, "User Documentation for CVODES v7.0.0," - LLNL technical report UCRL-SM-208111, Feb 2024. + and C. S. Woodward, "User Documentation for CVODES v7.1.0," + LLNL technical report UCRL-SM-208111, Jun 2024. -* A. C. Hindmarsh and R. Serban, "Example Programs for CVODES v7.0.0," - LLNL technical report UCRL-SM-208115, Feb 2024. +* A. C. Hindmarsh and R. Serban, "Example Programs for CVODES v7.1.0," + LLNL technical report UCRL-SM-208115, Jun 2024. * R. Serban and A. C. Hindmarsh, "CVODES: the Sensitivity-Enabled ODE solver in SUNDIALS," Proceedings of IDETC/CIE 2005, Sept. 2005, diff --git a/src/ida/README.md b/src/ida/README.md index 325acccc19..086ea1c262 100644 --- a/src/ida/README.md +++ b/src/ida/README.md @@ -1,5 +1,5 @@ # IDA -### Version 7.0.0 (Feb 2024) +### Version 7.1.0 (Jun 2024) **Alan C. Hindmarsh, Radu Serban, Cody J. Balos, David J. Gardner, and Carol S. Woodward, Center for Applied Scientific Computing, LLNL** @@ -47,11 +47,11 @@ the "SUNDIALS Release History" appendix of the IDA User Guide. ## References * A. C. Hindmarsh, R. Serban, C. J. Balos, D. J. Gardner, D. R. Reynolds - and C. S. Woodward, "User Documentation for IDA v7.0.0," - LLNL technical report UCRL-SM-208112, Feb 2024. + and C. S. Woodward, "User Documentation for IDA v7.1.0," + LLNL technical report UCRL-SM-208112, Jun 2024. -* A. C. Hindmarsh, R. Serban, and A. Collier, "Example Programs for IDA v7.0.0," - LLNL technical report UCRL-SM-208113, Feb 2024. +* A. C. Hindmarsh, R. Serban, and A. Collier, "Example Programs for IDA v7.1.0," + LLNL technical report UCRL-SM-208113, Jun 2024. * A. C. Hindmarsh, P. N. Brown, K. E. Grant, S. L. Lee, R. Serban, D. E. Shumaker, and C. S. Woodward, "SUNDIALS, Suite of Nonlinear and diff --git a/src/idas/README.md b/src/idas/README.md index 7fd2909139..0b34eb22e7 100644 --- a/src/idas/README.md +++ b/src/idas/README.md @@ -1,5 +1,5 @@ # IDAS -### Version 6.0.0 (Feb 2024) +### Version 6.1.0 (Jun 2024) **Radu Serban, Cosmin Petra, Alan C. Hindmarsh, Cody J. Balos, David J. Gardner, and Carol S. Woodward, Center for Applied Scientific Computing, LLNL** @@ -43,11 +43,11 @@ the "SUNDIALS Release History" appendix of the IDAS User Guide. ## References * R. Serban, C. Petra, A. C. Hindmarsh, C. J. Balos, D. J. Gardner, - D. R. Reynolds and C. S. Woodward, "User Documentation for IDAS v6.0.0," - LLNL technical report UCRL-SM-234051, Feb 2024. + D. R. Reynolds and C. S. Woodward, "User Documentation for IDAS v6.1.0," + LLNL technical report UCRL-SM-234051, Jun 2024. -* R. Serban and A.C. Hindmarsh, "Example Programs for IDAS v6.0.0," - LLNL technical report LLNL-TR-437091, Feb 2024. +* R. Serban and A.C. Hindmarsh, "Example Programs for IDAS v6.1.0," + LLNL technical report LLNL-TR-437091, Jun 2024. * A. C. Hindmarsh, P. N. Brown, K. E. Grant, S. L. Lee, R. Serban, D. E. Shumaker, and C. S. Woodward, "SUNDIALS, Suite of Nonlinear and diff --git a/src/kinsol/README.md b/src/kinsol/README.md index 6433b7c77b..84678f7713 100644 --- a/src/kinsol/README.md +++ b/src/kinsol/README.md @@ -1,5 +1,5 @@ # KINSOL -### Version 7.0.0 (Feb 2024) +### Version 7.1.0 (Jun 2024) **Alan C. Hindmarsh, Radu Serban, Cody J. Balos, David J. Gardner, and Carol S. Woodward, Center for Applied Scientific Computing, LLNL** @@ -48,11 +48,11 @@ the "SUNDIALS Release History" appendix of the KINSOL User Guide. * A. C. Hindmarsh, R. Serban, C. J. Balos, D. J. Gardner, D. R. Reynolds and C. S. Woodward, - "User Documentation for KINSOL v7.0.0," LLNL technical report - UCRL-SM-208116, Feb 2024. + "User Documentation for KINSOL v7.1.0," LLNL technical report + UCRL-SM-208116, Jun 2024. -* A. M. Collier and R. Serban, "Example Programs for KINSOL v7.0.0," - LLNL technical report UCRL-SM-208114, Feb 2024. +* A. M. Collier and R. Serban, "Example Programs for KINSOL v7.1.0," + LLNL technical report UCRL-SM-208114, Jun 2024. * A. C. Hindmarsh, P. N. Brown, K. E. Grant, S. L. Lee, R. Serban, D. E. Shumaker, and C. S. Woodward, "SUNDIALS, Suite of Nonlinear and