Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel R. Reynolds <reynolds@smu.edu>
  • Loading branch information
balos1 and drreynolds authored Dec 4, 2023
1 parent 5c5ef87 commit 8481f43
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/cvode/guide/source/Usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ more information).
Other headers may be needed, according to the choice of preconditioner, etc. For example, in the
example (see :cite:p:`cvode_ex`), preconditioning is done with a block-diagonal matrix. For this,
even though the ``SUNLINSOL_SPGMR`` linear solver is used, the header
``sundials dense.h`` is included for access to the underlying generic dense matrix
``sundials_dense.h`` is included for access to the underlying generic dense matrix
arithmetic routines.

.. _CVODE.Usage.CC.skeleton_sim:
Expand Down
2 changes: 1 addition & 1 deletion doc/cvodes/guide/source/Usage/SIM.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ more information).
Other headers may be needed, according to the choice of preconditioner, etc. For example, in the
example (see :cite:p:`cvodes_ex`), preconditioning is done with a block-diagonal matrix. For this,
even though the ``SUNLINSOL_SPGMR`` linear solver is used, the header
``sundials dense.h`` is included for access to the underlying generic dense matrix
``sundials_dense.h`` is included for access to the underlying generic dense matrix
arithmetic routines.

.. warning::
Expand Down
6 changes: 3 additions & 3 deletions include/sundials/priv/sundials_errors_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ void SUNHandleErrWithFmtMsg(int line, const char* func, const char* file,
* We define several different version of SUNCheck* macros to cover various
* programming scenarios.
*
* SUNCheckCall* macros are used to check SUNDIALS functions calls which do
* SUNCheckCall* macros are used to check SUNDIALS function calls which do
* return a SUNErrCode.
*
* SUNCheckLastErr* macros are used to check SUNDIALS function calls that
Expand Down Expand Up @@ -278,7 +278,7 @@ void SUNHandleErrWithFmtMsg(int line, const char* func, const char* file,

/* SUNCheckLastErrMoRetMsg checks the last_err value in the SUNContext.
If an error occured, then it will log the error, set the last_err
value, and calls the error handler. */
value, and call the error handler. */
#if defined(SUNDIALS_ENABLE_ERROR_CHECKS)
#define SUNCheckLastErrMsg(msg) \
SUNCheckCallMsg(SUNContext_GetLastError(SUNCTX_), msg)
Expand All @@ -305,7 +305,7 @@ void SUNHandleErrWithFmtMsg(int line, const char* func, const char* file,
/*
SUNAssert checks if an expression is true. It expands to SUNCheck when error
checks are enabled. If error checks are disabled, then we try to expand it to
an assumption, if the compiler supoprts, so that the compiler can make
an assumption, if the compiler supports, so that the compiler can make
optimizations based on the assumption.
:param expr: a expression to evaluate as true or false
Expand Down
8 changes: 4 additions & 4 deletions include/sundials/priv/sundials_mpi_errors_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/*
SUNCheckMPICallMsg performs the MPI function call, and checks the
returned error code. If an error occured, then it will log the error, set the
last_err value, call the error handler, **and then returns SUN_ERR_MPI_FAIL**.
last_err value, call the error handler, **and then return SUN_ERR_MPI_FAIL**.
:param call: the MPI function call
:param msg: an error message
Expand All @@ -51,7 +51,7 @@
/*
SUNCheckMPICallNullMsg performs the MPI function call, and checks the
returned error code. If an error occured, then it will log the error, set the
last_err value, call the error handler, **and then returns NULL**.
last_err value, call the error handler, **and then return NULL**.
:param call: the MPI function call
:param msg: an error message
Expand All @@ -75,7 +75,7 @@
/*
SUNCheckMPICallVoidMsg performs the MPI function call, and checks the
returned error code. If an error occured, then it will log the error, set the
last_err value, call the error handler, **and then returns void**.
last_err value, call the error handler, **and then return void**.
:param call: the MPI function call
:param msg: an error message
Expand All @@ -99,7 +99,7 @@
/*
SUNCheckMPICallNoRetMsg performs the MPI function call, and checks the
returned error code. If an error occured, then it will log the error, set the
last_err value, call the error handler. **It does not return**.
last_err value, and call the error handler. **It does not return**.
:param call: the MPI function call
:param msg: an error message
Expand Down

0 comments on commit 8481f43

Please sign in to comment.