From 1bb51a7bf7c065999550aa0c63749e01e71e540e Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" Date: Wed, 13 Dec 2023 13:53:03 -0800 Subject: [PATCH] doc fixes --- .../SUNAdaptController_ImExGus.rst | 2 +- .../SUNAdaptController_Soderlind.rst | 12 ++++++------ doc/shared/sunmemory/SUNMemory_CUDA.rst | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst b/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst index 2963bd4667..2a052c566d 100644 --- a/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst +++ b/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst @@ -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 diff --git a/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst b/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst index 56243ec4af..4a4ed4ad89 100644 --- a/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst +++ b/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst @@ -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 @@ -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 @@ -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 @@ -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 @@ -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`. @@ -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`. diff --git a/doc/shared/sunmemory/SUNMemory_CUDA.rst b/doc/shared/sunmemory/SUNMemory_CUDA.rst index be14ff97e9..1f2cb99495 100644 --- a/doc/shared/sunmemory/SUNMemory_CUDA.rst +++ b/doc/shared/sunmemory/SUNMemory_CUDA.rst @@ -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, \