Skip to content

Commit bbf661e

Browse files
committed
add missing parameter in KINLsJacTimesVecFn docs
1 parent e94cb39 commit bbf661e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/kinsol/guide/source/Usage/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2157,6 +2157,15 @@ supplied, the default is a difference quotient approximation to these products.
21572157
* ``v`` -- is the vector by which the Jacobian must be multiplied to the right.
21582158
* ``Jv`` -- is the computed output vector.
21592159
* ``u`` -- is the current value of the dependent variable vector.
2160+
* ``new_u`` -- is a flag, input from KINSOL and possibly reset by this
2161+
function, indicating whether the iterate vector ``u`` has been updated
2162+
since the last call to this function. This is useful if this function
2163+
computes and saves Jacobian data that depends on ``u`` for use in
2164+
computing :math:`J(u) v`. The input value of ``new_u`` is ``SUNTRUE``
2165+
following an update by KINSOL, and in that case any saved Jacobian data
2166+
depending on ``u`` should be recomputed. This function should then set
2167+
``new_u`` to ``SUNFALSE``, so that on subsequent calls with the same
2168+
``u``, the saved data can be reused.
21602169
* ``user_data`` -- is a pointer to user data, the same as the ``user_data``
21612170
parameter passed to :c:func:`KINSetUserData`.
21622171

0 commit comments

Comments
 (0)