diff --git a/CHANGELOG.md b/CHANGELOG.md index dc3696389c..d88dd0dd35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -85,7 +85,7 @@ sundials_band.h **Breaking change** The following functions have had their signature updated to ensure they can leverage -the new SUNDIALS error handling capabilties. +the new SUNDIALS error handling capabilties. ```c // From sundials_futils.h @@ -130,7 +130,16 @@ accordingly. **Breaking change** Functions, types and header files that were previously deprecated have been -removed. +removed. In addittion the following names/symbols were replaced by ``SUN_ERR_*`` +codes: + +``` +SUNMAT_SUCCESS --> SUN_SUCCESS +SUNMAT_ILL_INPUT --> SUN_ERR_ARG_* +SUNMAT_MEM_FAIL --> SUN_ERR_MEM_FAIL +SUNMAT_OPERATION_FAIL --> SUN_ERR_OP_FAIL +SUNMAT_MATVEC_SETUP_REQUIRED --> SUN_ERR_OP_FAIL +``` **Breaking change** Users now need to link to `sundials_core` in addition to the libraries already linked to. diff --git a/doc/shared/sunmatrix/SUNMatrix_Operations.rst b/doc/shared/sunmatrix/SUNMatrix_Operations.rst index 3e5331dd1d..1dc040841f 100644 --- a/doc/shared/sunmatrix/SUNMatrix_Operations.rst +++ b/doc/shared/sunmatrix/SUNMatrix_Operations.rst @@ -170,27 +170,3 @@ below. .. code-block:: c retval = SUNMatMatvec(A, x, y); - - -.. _SUNMatrix.Ops.errorCodes: - -SUNMatrix return codes ----------------------- - -The functions provided to SUNMatrix modules within the SUNDIALS-provided -SUNMatrix implementations utilize a common set of return codes, listed below. -These adhere to a common pattern: 0 indicates success, a negative value -indicates a failure. Aside from this pattern, the actual values of each error -code are primarily to provide additional information to the user in case of a -SUNMatrix failure. - -* ``SUN_SUCCESS`` (0) -- successful call - -* ``SUN_ERR_ARG_INCOMPATIBLE`` (-1) -- an illegal input has been provided to the function - -* ``SUN_ERR_MEM_FAIL`` (-2) -- failed memory access or allocation - -* ``SUN_ERR_OP_FAIL`` (-3) -- a SUNMatrix operation returned nonzero - -* ``SUN_ERR_OP_FAIL`` (-4) -- the :c:func:`SUNMatMatvecSetup` routine needs to be - called prior to calling :c:func:`SUNMatMatvec`