Skip to content

Commit

Permalink
Applied suggestions from code review.
Browse files Browse the repository at this point in the history
  • Loading branch information
drreynolds committed May 11, 2024
1 parent c9f42e1 commit 72548a2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ simplified code maintenance. Marked the corresponding stepper-specific
user-callable routines as deprecated; these will be removed in a future major
release.

Added "Resize" capability to ARKODE's SPRKStep time-stepping module.
Added "Resize" capability, as well as missing `SetRootDirection` and
`SetNoInactiveRootWarn` functions, to ARKODE's SPRKStep time-stepping module.

Deprecated `ARKStepSetOptimalParams` function; added instructions to user guide
for users who wish to retain the current functionality.
Expand Down
5 changes: 3 additions & 2 deletions doc/shared/RecentChanges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ simplified code maintenance. Marked the corresponding stepper-specific
user-callable routines as deprecated; these will be removed in a future major
release.

Added "Resize" capability to ARKODE's SPRKStep time-stepping module.
Added "Resize" capability, as well as missing ``SetRootDirection`` and
``SetNoInactiveRootWarn`` functions, to ARKODE's SPRKStep time-stepping module.

Deprecated ``ARKStepSetOptimalParams`` function; added instructions to user guide
for users who wish to retain the current functionality.
Expand Down Expand Up @@ -40,4 +41,4 @@ Fixed a bug that caused error messages to be cut off in some cases. Fixes `GitHu

Fixed a memory leak when an error handler was added to a :c:type:`SUNContext`. Fixes `GitHub Issue #466 <https://github.com/LLNL/sundials/issues/466>`_.

Fixed a CMake bug that caused an MPI linking error for our C++ examples in some instances. Fixes `GitHub Issue #464 <https://github.com/LLNL/sundials/issues/464>`_.
Fixed a CMake bug that caused an MPI linking error for our C++ examples in some instances. Fixes `GitHub Issue #464 <https://github.com/LLNL/sundials/issues/464>`_.
16 changes: 6 additions & 10 deletions src/arkode/arkode_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -575,11 +575,6 @@ void arkProcessError(ARKodeMem ark_mem, int error_code, int line,
/*===============================================================
ARKODE PRIVATE FUNCTION PROTOTYPES
===============================================================*/
#ifdef __GNUC__
#define SUNDIALS_UNUSED __attribute__((unused))
#else
#define SUNDIALS_UNUSED
#endif

ARKodeMem arkCreate(SUNContext sunctx);
int arkInit(ARKodeMem ark_mem, sunrealtype t0, N_Vector y0, int init_type);
Expand Down Expand Up @@ -813,7 +808,7 @@ int arkGetLastKFlag(void* arkode_mem, int* last_kflag);
parameters are as follows:
arkode_mem - void* problem memory pointer of type ARKodeMem. See
the typedef earlier in this file.
the typedef earlier in this file.
convfail - a flag to indicate any problem that occurred during
the solution of the nonlinear equation on the
Expand Down Expand Up @@ -859,10 +854,11 @@ int arkGetLastKFlag(void* arkode_mem, int* last_kflag);
N-vector ycur contains the solver's current approximation to
y(tcur) and the vector fcur contains the N_Vector f(tcur,ycur).
The input client_tol contains the desired accuracy (in the wrms
norm) of the routine calling the solver; the ARKDLS solver
ignores this value and the ARKSPILS solver tightens it by the
norm) of the routine calling the solver; the direct solvers
ignore this value and iterative solvers tighten it by the
factor eplifac. The input mnewt is the current nonlinear
iteration index (ignored by ARKDLS, used by ARKSPILS).
iteration index (ignored by direct solvers, used by iterative
solvers).
Additional vectors that are set within the ARKODE memory
structure, and that may be of use within an iterative linear
Expand Down Expand Up @@ -1113,7 +1109,7 @@ int arkGetLastKFlag(void* arkode_mem, int* last_kflag);
ARKTimestepPrintMem
This optional routine allows the stepper to output any internal
memory typically for debugging purposes) when ARKodePrintMem is
memory (typically for debugging purposes) when ARKodePrintMem is
called.
---------------------------------------------------------------
Expand Down

0 comments on commit 72548a2

Please sign in to comment.