Skip to content

Commit

Permalink
revision
Browse files Browse the repository at this point in the history
  • Loading branch information
maggul committed Sep 27, 2024
1 parent 7f10591 commit 418f60b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 11 deletions.
9 changes: 4 additions & 5 deletions doc/arkode/guide/source/Usage/LSRKStep/User_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,15 +214,14 @@ Optional output functions
------------------------------


.. c:function:: int LSRKStepGetNumRhsEvals(void* arkode_mem, long int* fe_evals, long int* fi_evals);
.. c:function:: int LSRKStepGetNumRhsEvals(void* arkode_mem, int num_rhs_fn, long int* f_evals);
Returns the number of calls to the user's right-hand
side functions, :math:`f^E` and :math:`f^I` (so far).
Returns the number of calls to the user's right-hand side functions.

**Arguments:**
* *arkode_mem* -- pointer to the LSRKStep memory block.
* *fe_evals* -- number of calls to the user's :math:`f^E(t,y)` function.
* *fi_evals* -- number of calls to the user's :math:`f^I(t,y)` function.
* *num_rhs_fn* -- number of input RHS functions.
* *f_evals* -- number of calls to the user's :math:`f(t,y)` function.

**Return value:**
* *ARK_SUCCESS* if successful
Expand Down
3 changes: 1 addition & 2 deletions include/arkode/arkode_lsrkstep.h
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@ SUNDIALS_EXPORT int LSRKStepSetSSPStageNum(void* arkode_mem, int num_of_stages);

/* Optional output functions */

SUNDIALS_EXPORT int LSRKStepGetNumRhsEvals(void* arkode_mem, long int* fe_evals,
long int* fi_evals);
SUNDIALS_EXPORT int LSRKStepGetNumRhsEvals(void* arkode_mem, int num_rhs_fn, long int* f_evals);

SUNDIALS_EXPORT int LSRKStepGetNumDomEigUpdates(void* arkode_mem,
long int* num_dom_eig_updates);
Expand Down
6 changes: 2 additions & 4 deletions src/arkode/arkode_lsrkstep_io.c
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,7 @@ int LSRKStepSetSSPStageNum(void* arkode_mem, int num_of_stages)
Returns the current number of calls to f
---------------------------------------------------------------*/
int LSRKStepGetNumRhsEvals(void* arkode_mem, long int* fe_evals,
long int* fi_evals)
int LSRKStepGetNumRhsEvals(void* arkode_mem, int num_rhs_fn, long int* f_evals)
{
ARKodeMem ark_mem;
ARKodeLSRKStepMem step_mem;
Expand All @@ -338,8 +337,7 @@ int LSRKStepGetNumRhsEvals(void* arkode_mem, long int* fe_evals,
if (retval != ARK_SUCCESS) { return (retval); }

/* get values from step_mem */
*fe_evals = step_mem->nfe;
*fi_evals = step_mem->nfi;
*f_evals = step_mem->nfe;

return (ARK_SUCCESS);
}
Expand Down

0 comments on commit 418f60b

Please sign in to comment.