Skip to content

Commit

Permalink
Bugfix: ARKODE ONE_STEP Description (#362)
Browse files Browse the repository at this point in the history
Fix the description of `ONE_STEP` mode in ARKODE. The solution at the
end of the step is always returned and interpolation is not performed.
  • Loading branch information
gardner48 committed Dec 18, 2023
1 parent 3719cd2 commit 2c2d87b
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -726,11 +726,8 @@ the user has set a stop time (with a call to the optional input function
in :numref:`ARKODE.Mathematics.Interpolation`).
The *ARK_ONE_STEP* option tells the solver to only take a
single internal step :math:`y_{n-1} \to y_{n}` and then return
control back to the calling program. If this step will
overtake *tout* then the solver will again return an
interpolated result; otherwise it will return a copy of the
internal solution :math:`y_{n}` in the vector *yout*.
single internal step, :math:`y_{n-1} \to y_{n}`, and return the solution
at that point, :math:`y_{n}`, in the vector *yout*.
**Return value:**
* *ARK_SUCCESS* if successful.
Expand Down Expand Up @@ -795,8 +792,8 @@ the user has set a stop time (with a call to the optional input function
only to get the direction and a rough scale of the independent
variable.

All failure return values are negative and so testing the return argument for
negative values will trap all :c:func:`ARKStepEvolve()` failures.
All failure return values are negative and so testing the return argument
for negative values will trap all :c:func:`ARKStepEvolve()` failures.

Since interpolation may reduce the accuracy in the reported
solution, if full method accuracy is desired the user should issue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -352,11 +352,8 @@ has requested rootfinding.
:numref:`ARKODE.Mathematics.Interpolation`).
The *ARK_ONE_STEP* option tells the solver to only take a
single internal step :math:`y_{n-1} \to y_{n}` and then return
control back to the calling program. If this step will
overtake *tout* then the solver will again return an
interpolated result; otherwise it will return a copy of the
internal solution :math:`y_{n}` in the vector *yout*.
single internal step, :math:`y_{n-1} \to y_{n}`, and return the solution
at that point, :math:`y_{n}`, in the vector *yout*.
**Return value:**
* *ARK_SUCCESS* if successful.
Expand Down Expand Up @@ -399,7 +396,9 @@ has requested rootfinding.

In *ARK_ONE_STEP* mode, *tout* is used only on the first call, and
only to get the direction and a rough scale of the independent
variable. All failure return values are negative and so testing the
variable.

All failure return values are negative and so testing the
return argument for negative values will trap all
:c:func:`ERKStepEvolve()` failures.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -545,11 +545,8 @@ the user has set a stop time (with a call to the optional input function
in :numref:`ARKODE.Mathematics.Interpolation`).
The *ARK_ONE_STEP* option tells the solver to only take a
single internal step :math:`y_{n-1} \to y_{n}` and then return
control back to the calling program. If this step will
overtake *tout* then the solver will again return an
interpolated result; otherwise it will return a copy of the
internal solution :math:`y_{n}` in the vector *yout*.
single internal step, :math:`y_{n-1} \to y_{n}`, and return the solution
at that point, :math:`y_{n}`, in the vector *yout*.
**Return value:**
* *ARK_SUCCESS* if successful.
Expand Down Expand Up @@ -604,8 +601,8 @@ the user has set a stop time (with a call to the optional input function
only to get the direction and a rough scale of the independent
variable.

All failure return values are negative and so testing the return argument for
negative values will trap all :c:func:`MRIStepEvolve()` failures.
All failure return values are negative and so testing the return argument
for negative values will trap all :c:func:`MRIStepEvolve()` failures.

Since interpolation may reduce the accuracy in the reported
solution, if full method accuracy is desired the user should issue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,8 @@ has requested rootfinding.
:numref:`ARKODE.Mathematics.Interpolation`).
The *ARK_ONE_STEP* option tells the solver to only take a
single internal step :math:`y_{n-1} \to y_{n}` and then return
control back to the calling program. If this step will
overtake *tout* then the solver will again return an
interpolated result; otherwise it will return a copy of the
internal solution :math:`y_{n}` in the vector *yout*.
single internal step, :math:`y_{n-1} \to y_{n}`, and return the
solution at that point, :math:`y_{n}`, in the vector *yout*.
:retval ARK_SUCCESS: if successful.
:retval ARK_ROOT_RETURN: if :c:func:`SPRKStepEvolve()` succeeded, and
Expand Down Expand Up @@ -191,7 +188,9 @@ has requested rootfinding.

In *ARK_ONE_STEP* mode, *tout* is used only on the first call, and
only to get the direction and a rough scale of the independent
variable. All failure return values are negative and so testing the
variable.

All failure return values are negative and so testing the
return argument for negative values will trap all
:c:func:`SPRKStepEvolve()` failures.

Expand Down

0 comments on commit 2c2d87b

Please sign in to comment.