Skip to content

Commit

Permalink
fix missing CVodeQuadSStolerances
Browse files Browse the repository at this point in the history
  • Loading branch information
balos1 committed Oct 19, 2023
1 parent e800b15 commit b7829d7
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion doc/cvodes/guide/source/Usage/SIM.rst
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.
**Arguments:**
* ``cvode_mem`` -- pointer to the CVODES memory block.
* ``reltolQ`` -- tolerances is the scalar relative error tolerance.
* ``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

0 comments on commit b7829d7

Please sign in to comment.