Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Undocumented return values for CVodeB and IDASolveB #580

Open
dweindl opened this issue Sep 28, 2024 · 0 comments
Open

Undocumented return values for CVodeB and IDASolveB #580

dweindl opened this issue Sep 28, 2024 · 0 comments

Comments

@dweindl
Copy link
Contributor

dweindl commented Sep 28, 2024

The sundials 7.1.1 documentation suggests that the only non-negative return value from CVodeB is CV_SUCCESS. However, it may also return CV_TSTOP_RETURN. (Unrelated: the last sentence in the Notes section of CVodeB is duplicated just below.)

The same applies to IDASolveB and IDA_TSTOP_RETURN.

I don't know whether *_TSTOP_RETURN should be added to the documentation, or whether these function should not return that at all. (Those return values can be observed, for example, in the cvsRoberts_ASAi_klu and idasRoberts_ASAi_klu examples.)

@dweindl dweindl added the triage label Sep 28, 2024
@balos1 balos1 added the docs label Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants