Skip to content

Commit

Permalink
couple of small doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
balos1 committed Oct 21, 2024
1 parent 02aa271 commit bba7343
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/shared/sunadjoint/SUNAdjointStepper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,24 @@ The :c:type:`SUNAdjointStepper` class has the following functions:
int64_t final_step_idx, N_Vector sf, sunrealtype tf, SUNAdjointCheckpointScheme checkpoint_scheme, \
SUNContext sunctx, SUNAdjointStepper* adj_stepper)
Creates the ``SUNAdjointStepper`` object needed to solve the adjoint problem.
:param fwd_sunstepper: The :c:type:`SUNStepper` to be used for forward computations of the original ODE.
:param adj_sunstepper: The :c:type:`SUNStepper` to be usef for the backward integration of the adjoint ODE.
:param final_step_idx: The index (step number) of the step corresponding to ``t_f`` for the forward ODE.
:param sf: The terminal condition for the adjoint ODE.
:param tf: The terminal time for the forward ODE and (which is the initial time for the adjoint ODE).
:param checkpoint_scheme: The :c:type:`SUNAdjointCheckpointScheme` object that determines the checkpointing strategy to use. This should be the same scheme provided to the forward integrator/stepper.
:param sunctx: The :c:type:`SUNContext` for the simulation context.
.. c:function:: SUNErrCode SUNAdjointStepper_ReInit(SUNAdjointStepper adj, N_Vector sf, sunrealtype tf)
Reinitializes the adjoint stepper to solve a new problem of the same size.
:param adj_stepper: The adjoint solver object.
:param sf: The terminal condition vector of sensitivity solutions :math:`dg/dy_0`` and :math:`dg/dp`.
:param tf: The time to start integrating the adjoint system from.
:param sf: The terminal condition vector of sensitivity solutions dg/dy0 and dg/dp.
:return: A :c:type:`SUNErrCode` indicating failure or success.
Expand Down

0 comments on commit bba7343

Please sign in to comment.