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.

Sign up for GitHub

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

Bugfix/docs missing cvodequadsstolerances #352

Merged
merged 5 commits into from
Oct 20, 2023
Merged

Bugfix/docs missing cvodequadsstolerances #352

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bce7294
fix reference
balos1 Aug 7, 2023
b7829d7
fix missing CVodeQuadSStolerances
balos1 Oct 19, 2023
4ed0e75
fixed typo
balos1 Oct 19, 2023
b74d41f
fix typo
balos1 Oct 19, 2023
54ca065
Merge remote-tracking branch 'origin/bugfix/cvodes-doc-typo' into bug…
balos1 Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion doc/cvodes/guide/source/Usage/SIM.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4122,7 +4122,7 @@ If the quadrature variables are part of the step size control mechanism,
one of the following functions must be called to specify the
integration tolerances for quadrature variables.

.. c:function:: int CVodeQuadSVtolerances(void * cvode_mem, realtype reltolQ, N_Vector abstolQ)
.. c:function:: int CVodeQuadSStolerances(void *cvode_mem, realtype reltolQ, realtype abstolQ)

The function ``CVodeQuadSStolerances`` specifies scalar relative and absolute tolerances.

Expand All @@ -4138,6 +4138,22 @@ integration tolerances for quadrature variables.
* ``CV_ILL_INPUT`` -- One of the input tolerances was negative.


.. c:function:: int CVodeQuadSVtolerances(void * cvode_mem, realtype reltolQ, N_Vector abstolQ)

The function ``CVodeQuadSVtolerances`` specifies scalar relative and absolute tolerances.
balos1 marked this conversation as resolved.
Show resolved Hide resolved

**Arguments:**
* ``cvode_mem`` -- pointer to the CVODES memory block.
* ``reltolQ`` -- tolerances is the scalar relative error tolerance.
balos1 marked this conversation as resolved.
Show resolved Hide resolved
* ``abstolQ`` -- the vector of absolute error tolerances.

**Return value:**
* ``CV_SUCCESS`` -- The optional value has been successfully set.
* ``CV_NO_QUAD`` -- Quadrature integration was not initialized.
* ``CV_MEM_NULL`` -- The ``cvode_mem`` pointer is ``NULL``.
* ``CV_ILL_INPUT`` -- One of the input tolerances was negative.


.. _CVODES.Usage.purequad.optional_output:

Optional outputs for quadrature integration
Expand Down