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 <[email protected]>
  • Loading branch information
balos1 and drreynolds authored Dec 13, 2023
1 parent ee946c8 commit f478e59
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
16 changes: 8 additions & 8 deletions doc/shared/sunadaptcontroller/SUNAdaptController_Description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
routine).
:param C: the :c:type:`SUNAdaptController` object.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -166,7 +166,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
:param p: the current order of accuracy for the time integration method.
:param dsm: the local temporal estimate from the previous step attempt.
:param hnew: (output) the estimated step size.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -180,7 +180,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
of previous *dsm* or *h* values.
:param C: the :c:type:`SUNAdaptController` object.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -193,7 +193,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
Sets the controller parameters to their default values.
:param C: the :c:type:`SUNAdaptController` object.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -207,7 +207,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
:param C: the :c:type:`SUNAdaptController` object.
:param fptr: the output stream to write the parameters to.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -224,7 +224,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
:param C: the :c:type:`SUNAdaptController` object.
:param bias: the error bias factor -- an input :math:`\leq 0` indicates to use
the default value for the controller.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -243,7 +243,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
:param C: the :c:type:`SUNAdaptController` object.
:param h: the successful step size.
:param dsm: the successful temporal error estimate.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand All @@ -262,7 +262,7 @@ note these requirements below. Additionally, we note the behavior of the base SU
:param leniw: (output) number of ``sunindextype`` words stored in the
controller. This may also include pointers, `int` and
`long int` words.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ routines:
:param k2e: parameter used within the controller time step estimate.
:param k1i: parameter used within the controller time step estimate.
:param k2i: parameter used within the controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success or failure
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand Down
12 changes: 6 additions & 6 deletions doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ also provides the following additional user-callable routines:
:param k3: parameter used within the controller time step estimate.
:param k4: parameter used within the controller time step estimate.
:param k5: parameter used within the controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success of failure.
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand Down Expand Up @@ -147,7 +147,7 @@ also provides the following additional user-callable routines:
:param k1: parameter used within the controller time step estimate.
:param k2: parameter used within the controller time step estimate.
:param k3: parameter used within the controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success of failure.
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand Down Expand Up @@ -181,7 +181,7 @@ also provides the following additional user-callable routines:
:param C: the SUNAdaptController_Soderlind object.
:param k1: parameter used within the controller time step estimate.
:param k2: parameter used within the controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success of failure.
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand Down Expand Up @@ -214,7 +214,7 @@ also provides the following additional user-callable routines:
:param C: the SUNAdaptController_Soderlind object.
:param k1: parameter used within the controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success of failure.
:return: :c:type:`SUNErrCode` indicating success or failure.
Usage:
Expand Down Expand Up @@ -260,7 +260,7 @@ also provides the following additional user-callable routines:
:param C: the SUNAdaptController_Soderlind object.
:param k1_hat: parameter used within the explicit Gustafsson controller time step estimate.
:param k2_hat: parameter used within the explicit Gustafsson controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success of failure.
:return: :c:type:`SUNErrCode` indicating success or failure.

Usage:

Expand Down Expand Up @@ -306,7 +306,7 @@ also provides the following additional user-callable routines:
:param C: the SUNAdaptController_Soderlind object.
:param k1_hat: parameter used within the implicit Gustafsson controller time step estimate.
:param k2_hat: parameter used within the implicit Gustafsson controller time step estimate.
:return: :c:type:`SUNErrCode` indicating success of failure.
:return: :c:type:`SUNErrCode` indicating success or failure.

Usage:

Expand Down
10 changes: 5 additions & 5 deletions doc/shared/sunmemory/SUNMemory_CUDA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The implementation provides the following operations defined by the
**Returns:**
* A :c:type:`SUNErrCode` indicating success or failure
* A :c:type:`SUNErrCode` indicating success or failure.
.. c:function:: SUNErrCode SUNMemoryHelper_Dealloc_Cuda(SUNMemoryHelper helper, \
Expand All @@ -85,7 +85,7 @@ The implementation provides the following operations defined by the
**Returns:**
* A :c:type:`SUNErrCode` indicating success or failure
* A :c:type:`SUNErrCode` indicating success or failure.
.. c:function:: SUNErrCode SUNMemoryHelper_Copy_Cuda(SUNMemoryHelper helper, \
Expand All @@ -108,7 +108,7 @@ The implementation provides the following operations defined by the
**Returns:**
* A :c:type:`SUNErrCode` indicating success or failure
* A :c:type:`SUNErrCode` indicating success or failure.
.. c:function:: SUNErrCode SUNMemoryHelper_CopyAsync_Cuda(SUNMemoryHelper helper, \
Expand All @@ -133,7 +133,7 @@ The implementation provides the following operations defined by the
**Returns:**
* A :c:type:`SUNErrCode` indicating success or failure
* A :c:type:`SUNErrCode` indicating success or failure.
.. c:function:: SUNErrCode SUNMemoryHelper_GetAllocStats_Cuda(SUNMemoryHelper helper, SUNMemoryType mem_type, unsigned long* num_allocations, \
Expand All @@ -153,4 +153,4 @@ The implementation provides the following operations defined by the
**Returns:**
* A :c:type:`SUNErrCode` indicating success or failure
* A :c:type:`SUNErrCode` indicating success or failure.

0 comments on commit f478e59

Please sign in to comment.