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

Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion doc/cvodes/guide/source/Usage/ADJ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ several supporting user-callable functions. For this reason, in the following
sections we refer to the *backward problem* and not to the *adjoint problem*
when discussing details relevant to the ODEs that are integrated backward in
time. The backward problem can be the adjoint problem :eq:`CVODES_adj_eqns` or
:eq:`CVODES_adj_eqns`, and can be augmented with some quadrature differential
:eq:`CVODES_adj1_eqns`, and can be augmented with some quadrature differential
equations.

CVODES uses various constants for both input and output. These are defined as
Expand Down
22 changes: 19 additions & 3 deletions 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,13 +4122,13 @@ 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.
The function ``CVodeQuadSStolerances`` specifies scalar relative and absolute tolerances.

**Arguments:**
* ``cvode_mem`` -- pointer to the CVODES memory block.
* ``reltolQ`` -- tolerances is the scalar relative error tolerance.
* ``reltolQ`` -- is the scalar relative error tolerance.
* ``abstolQ`` -- is the scalar absolute error tolerance.

**Return value:**
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 vector absolute tolerances.

**Arguments:**
* ``cvode_mem`` -- pointer to the CVODES memory block.
* ``reltolQ`` -- 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