From 75a6c7d9f5bb16a0055f57c18237b18effefae58 Mon Sep 17 00:00:00 2001 From: David Gardner Date: Wed, 28 Jun 2023 09:03:19 -0700 Subject: [PATCH] Documentation Fixes (#295) Fix some documentation errors and typos (addresses issue #280) --- doc/cvode/guide/source/Usage/index.rst | 6 +++--- doc/cvodes/guide/source/Usage/ADJ.rst | 4 ++-- doc/cvodes/guide/source/Usage/SIM.rst | 10 +++++----- doc/ida/guide/source/Usage/index.rst | 2 +- doc/idas/guide/source/Usage/SIM.rst | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/cvode/guide/source/Usage/index.rst b/doc/cvode/guide/source/Usage/index.rst index 0f425c4b96..b2f1b7d7a3 100644 --- a/doc/cvode/guide/source/Usage/index.rst +++ b/doc/cvode/guide/source/Usage/index.rst @@ -713,7 +713,7 @@ of two modes as to where CVODE is to return a solution. But these modes are modified if the user has set a stop time (with :c:func:`CVodeSetStopTime`) or requested rootfinding. -.. c:function:: int CVode(void* cvode_mem, realtype tout, N_Vector yout, realtype tret, int itask) +.. c:function:: int CVode(void* cvode_mem, realtype tout, N_Vector yout, realtype* tret, int itask) The function ``CVode`` integrates the ODE over an interval in t. @@ -1630,8 +1630,8 @@ the :c:func:`CVodeSetEpsLin` function. .. _CVODE.Usage.CC.optional_input.optin_nls: -Linear solver interface optional input functions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Nonlinear solver interface optional input functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _CVODE.Usage.CC.optional_input.optin_nls_table: diff --git a/doc/cvodes/guide/source/Usage/ADJ.rst b/doc/cvodes/guide/source/Usage/ADJ.rst index a6431e8882..8552d514f3 100644 --- a/doc/cvodes/guide/source/Usage/ADJ.rst +++ b/doc/cvodes/guide/source/Usage/ADJ.rst @@ -383,7 +383,7 @@ use in Forward Sensitivity Analysis; for that, see :numref:`CVODES.Usage.FSA`. The call to this function has the form -.. c:function:: int CVodeF(void * cvode_mem, realtype tout, N_Vector yret, realtype tret, int itask, int ncheck) +.. c:function:: int CVodeF(void * cvode_mem, realtype tout, N_Vector yret, realtype* tret, int itask, int ncheck) The function :c:func:`CVodeF` integrates the forward problem over an interval in :math:`t` and saves checkpointing data. @@ -1353,7 +1353,7 @@ To extract the values of the quadrature variables at the last return time of :c:func:`CVodeGetQuad`. -.. c:function:: int CVodeGetQuadB(void * cvode_mem, whichrealtype tret, N_Vector yQB) +.. c:function:: int CVodeGetQuadB(void * cvode_mem, int which, realtype* tret, N_Vector yQB) The function :c:func:`CVodeGetQuadB` returns the quadrature solution vector after a successful return from :c:func:`CVodeB`. diff --git a/doc/cvodes/guide/source/Usage/SIM.rst b/doc/cvodes/guide/source/Usage/SIM.rst index 826ee20e29..5bfae0d931 100644 --- a/doc/cvodes/guide/source/Usage/SIM.rst +++ b/doc/cvodes/guide/source/Usage/SIM.rst @@ -721,7 +721,7 @@ of two modes as to where CVODES is to return a solution. But these modes are modified if the user has set a stop time (with :c:func:`CVodeSetStopTime`) or requested rootfinding. -.. c:function:: int CVode(void* cvode_mem, realtype tout, N_Vector yout, realtype tret, int itask) +.. c:function:: int CVode(void* cvode_mem, realtype tout, N_Vector yout, realtype* tret, int itask) The function ``CVode`` integrates the ODE over an interval in t. @@ -1627,8 +1627,8 @@ the :c:func:`CVodeSetEpsLin` function. .. _CVODES.Usage.SIM.optional_input.optin_nls: -Linear solver interface optional input functions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Nonlinear solver interface optional input functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _CVODES.Usage.SIM.optional_input.optin_nls_table: @@ -4024,7 +4024,7 @@ solution and quadratures at time ``t``. However, :c:func:`CVode` will still retu only the solution :math:`y` in ``yout``. Solution quadratures can be obtained using the following function: -.. c:function:: int CVodeGetQuad(void * cvode_mem, realtype tret, N_Vector yQ) +.. c:function:: int CVodeGetQuad(void * cvode_mem, realtype* tret, N_Vector yQ) The function ``CVodeGetQuad`` returns the quadrature solution vector after a successful return from ``CVode``. @@ -4104,7 +4104,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, realtype abstolQ) +.. c:function:: int CVodeQuadSVtolerances(void * cvode_mem, realtype reltolQ, N_Vector abstolQ) The function ``CVodeQuadSStolerances`` specifies scalar relative and absolute tolerances. diff --git a/doc/ida/guide/source/Usage/index.rst b/doc/ida/guide/source/Usage/index.rst index 25bae3ecae..c6fca6bcee 100644 --- a/doc/ida/guide/source/Usage/index.rst +++ b/doc/ida/guide/source/Usage/index.rst @@ -792,7 +792,7 @@ the user has set a stop time (with :c:func:`IDASetStopTime`) or requested rootfinding (with :c:func:`IDARootInit`). -.. c:function:: int IDASolve(void * ida_mem, realtype tout, realtype tret, N_Vector yret, N_Vector ypret, int itask) +.. c:function:: int IDASolve(void * ida_mem, realtype tout, realtype* tret, N_Vector yret, N_Vector ypret, int itask) The function ``IDASolve`` integrates the DAE over an interval in t. diff --git a/doc/idas/guide/source/Usage/SIM.rst b/doc/idas/guide/source/Usage/SIM.rst index 2fc1896241..4bd1ac2738 100644 --- a/doc/idas/guide/source/Usage/SIM.rst +++ b/doc/idas/guide/source/Usage/SIM.rst @@ -3970,7 +3970,7 @@ then IDAS computes both a solution and quadratures at time ``t``. However, :c:func:`IDASolve` will still return only the solution :math:`y` in ``y``. Solution quadratures can be obtained using the following function: -.. c:function:: int IDAGetQuad(void * ida_mem, realtype tret, N_Vector yQ) +.. c:function:: int IDAGetQuad(void * ida_mem, realtype* tret, N_Vector yQ) The function :c:func:`IDAGetQuad` returns the quadrature solution vector after a successful return from :c:func:`IDASolve`.