Skip to content

Commit

Permalink
remove old docs
Browse files Browse the repository at this point in the history
  • Loading branch information
balos1 committed Dec 12, 2023
1 parent 8a3eb0b commit 5d1d643
Showing 1 changed file with 0 additions and 20 deletions.
20 changes: 0 additions & 20 deletions doc/shared/sunadaptcontroller/SUNAdaptController_Description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,26 +280,6 @@ note these requirements below. Additionally, we note the behavior of the base SU
.. _SUNAdaptController.Description.errorCodes:

SUNAdaptController Error Codes
------------------------------

SUNAdaptController functions return one of the following set of error codes:

* ``SUN_SUCCESS`` (0) -- successful call.

* ``SUNADAPTCONTROLLER_MEM_FAIL`` (-1002) -- a memory access or allocation failed.

* ``SUNADAPTCONTROLLER_OPERATION_FAIL`` (-1004) -- catch-all for errors not in the above list.

.. note::
The SUNDIALS time integrators do not rely on these specific return values and only
on whether the returned values are 0 (successful) or non-zero (failure). Thus,
user-defined implementations are not required to use these specific error codes,
so long as the zero/non-zero convention is followed.


C/C++ API Usage
---------------

Expand Down

0 comments on commit 5d1d643

Please sign in to comment.