Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
balos1 committed Dec 13, 2023
1 parent 089b6df commit 1bb51a7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ routines:
SUNAdaptController C = SUNAdaptController_ImExGus(sunctx);
.. c:function:: int SUNAdaptController_SetParams_ImExGus(SUNAdaptController C, sunrealtype k1e, sunrealtype k2e, sunrealtype k1i, sunrealtype k2i)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_ImExGus(SUNAdaptController C, sunrealtype k1e, sunrealtype k2e, sunrealtype k1i, sunrealtype k2i)
This user-callable function provides control over the relevant parameters
above. This should be called *before* the time integrator is called to evolve
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 @@ -99,7 +99,7 @@ also provides the following additional user-callable routines:
SUNAdaptController C = SUNAdaptController_Soderlind(sunctx);
.. c:function:: int SUNAdaptController_SetParams_Soderlind(SUNAdaptController C, sunrealtype k1, sunrealtype k2, sunrealtype k3, sunrealtype k4, sunrealtype k5)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_Soderlind(SUNAdaptController C, sunrealtype k1, sunrealtype k2, sunrealtype k3, sunrealtype k4, sunrealtype k5)
This user-callable function provides control over the relevant parameters
above. This should be called *before* the time integrator is called to evolve
Expand Down Expand Up @@ -137,7 +137,7 @@ also provides the following additional user-callable routines:
SUNAdaptController C = SUNAdaptController_PID(sunctx);
.. c:function:: int SUNAdaptController_SetParams_PID(SUNAdaptController C, sunrealtype k1, sunrealtype k2, sunrealtype k3)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_PID(SUNAdaptController C, sunrealtype k1, sunrealtype k2, sunrealtype k3)
This user-callable function provides control over the relevant parameters
above for a PID controller, setting :math:`k_4 = k_5 = 0`. This should be
Expand Down Expand Up @@ -172,7 +172,7 @@ also provides the following additional user-callable routines:
SUNAdaptController C = SUNAdaptController_PI(sunctx);
.. c:function:: int SUNAdaptController_SetParams_PI(SUNAdaptController C, sunrealtype k1, sunrealtype k2)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_PI(SUNAdaptController C, sunrealtype k1, sunrealtype k2)
This user-callable function provides control over the relevant parameters
above for a PI controller, setting :math:`k_3 = k_4 = k_5 = 0`. This should
Expand Down Expand Up @@ -206,7 +206,7 @@ also provides the following additional user-callable routines:
SUNAdaptController C = SUNAdaptController_I(sunctx);
.. c:function:: int SUNAdaptController_SetParams_I(SUNAdaptController C, sunrealtype k1)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_I(SUNAdaptController C, sunrealtype k1)
This user-callable function provides control over the relevant parameters
above for an I controller, setting :math:`k_2 = k_3 = k_4 = k_5 = 0`. This
Expand Down Expand Up @@ -240,7 +240,7 @@ also provides the following additional user-callable routines:
SUNAdaptController C = SUNAdaptController_ExpGus(sunctx);
.. c:function:: int SUNAdaptController_SetParams_ExpGus(SUNAdaptController C, sunrealtype k1_hat, sunrealtype k2_hat)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_ExpGus(SUNAdaptController C, sunrealtype k1_hat, sunrealtype k2_hat)
This user-callable function provides control over the relevant parameters
above for the explicit Gustafsson controller, setting :math:`k_3 = k_4 = k_5 = 0`.
Expand Down Expand Up @@ -286,7 +286,7 @@ also provides the following additional user-callable routines:
SUNAdaptController C = SUNAdaptController_ImpGus(sunctx);
.. c:function:: int SUNAdaptController_SetParams_ImpGus(SUNAdaptController C, sunrealtype k1_hat, sunrealtype k2_hat)
.. c:function:: SUNErrCode SUNAdaptController_SetParams_ImpGus(SUNAdaptController C, sunrealtype k1_hat, sunrealtype k2_hat)
This user-callable function provides control over the relevant parameters
above for the implicit Gustafsson controller, setting :math:`k_3 = k_4 = k_5 = 0`.
Expand Down
2 changes: 1 addition & 1 deletion 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 new :c:type:`SUNMemory` object.
.. c:function:: SUNErrCode SUNMemoryHelper_Dealloc_Cuda(SUNMemoryHelper helper, \
Expand Down

0 comments on commit 1bb51a7

Please sign in to comment.