21.4. arkode Submodule

21.4.1. Classes

A submodule of ‘sundials4py’

class sundials4py.arkode.ARKAccumError(*values)

ARK_ACCUMERROR_AVG = 3

ARK_ACCUMERROR_MAX = 1

ARK_ACCUMERROR_NONE = 0

ARK_ACCUMERROR_SUM = 2

class sundials4py.arkode.ARKODE_DIRKTableID(*values)

ARKODE_ARK2_DIRK_3_1_2 = 123

ARKODE_ARK324L2SA_DIRK_4_2_3 = 104

ARKODE_ARK436L2SA_DIRK_6_3_4 = 109

ARKODE_ARK437L2SA_DIRK_7_3_4 = 112

ARKODE_ARK548L2SA_DIRK_8_4_5 = 111

ARKODE_ARK548L2SAb_DIRK_8_4_5 = 113

ARKODE_BACKWARD_EULER_1_1 = 124

ARKODE_BILLINGTON_3_3_2 = 101

ARKODE_CASH_5_2_4 = 105

ARKODE_CASH_5_3_4 = 106

ARKODE_DIRK_NONE = -1

ARKODE_ESDIRK324L2SA_4_2_3 = 114

ARKODE_ESDIRK325L2SA_5_2_3 = 115

ARKODE_ESDIRK32I5L2SA_5_2_3 = 116

ARKODE_ESDIRK436L2SA_6_3_4 = 117

ARKODE_ESDIRK437L2SA_7_3_4 = 120

ARKODE_ESDIRK43I6L2SA_6_3_4 = 118

ARKODE_ESDIRK547L2SA2_7_4_5 = 122

ARKODE_ESDIRK547L2SA_7_4_5 = 121

ARKODE_IMPLICIT_MIDPOINT_1_2 = 125

ARKODE_IMPLICIT_TRAPEZOIDAL_2_2 = 126

ARKODE_KVAERNO_4_2_3 = 103

ARKODE_KVAERNO_5_3_4 = 108

ARKODE_KVAERNO_7_4_5 = 110

ARKODE_MAX_DIRK_NUM = 126

ARKODE_MIN_DIRK_NUM = 100

ARKODE_QESDIRK436L2SA_6_3_4 = 119

ARKODE_SDIRK_2_1_2 = 100

ARKODE_SDIRK_5_3_4 = 107

ARKODE_TRBDF2_3_3_2 = 102

class sundials4py.arkode.ARKODE_ERKTableID(*values)

ARKODE_ARK2_ERK_3_1_2 = 15

ARKODE_ARK324L2SA_ERK_4_2_3 = 2

ARKODE_ARK436L2SA_ERK_6_3_4 = 4

ARKODE_ARK437L2SA_ERK_7_3_4 = 13

ARKODE_ARK548L2SA_ERK_8_4_5 = 9

ARKODE_ARK548L2SAb_ERK_8_4_5 = 14

ARKODE_BOGACKI_SHAMPINE_4_2_3 = 1

ARKODE_CASH_KARP_6_4_5 = 6

ARKODE_DORMAND_PRINCE_7_4_5 = 8

ARKODE_ERK_NONE = -1

ARKODE_EXPLICIT_MIDPOINT_EULER_2_1_2 = 24

ARKODE_FEHLBERG_13_7_8 = 11

ARKODE_FEHLBERG_6_4_5 = 7

ARKODE_FORWARD_EULER_1_1 = 22

ARKODE_HEUN_EULER_2_1_2 = 0

ARKODE_KNOTH_WOLKE_3_3 = 12

ARKODE_MAX_ERK_NUM = 26

ARKODE_MIN_ERK_NUM = 0

ARKODE_RALSTON_3_1_2 = 25

ARKODE_RALSTON_EULER_2_1_2 = 23

ARKODE_SAYFY_ABURUB_6_3_4 = 5

ARKODE_SHU_OSHER_3_2_3 = 17

ARKODE_SOFRONIOU_SPALETTA_5_3_4 = 16

ARKODE_TSITOURAS_7_4_5 = 26

ARKODE_VERNER_10_6_7 = 19

ARKODE_VERNER_13_7_8 = 20

ARKODE_VERNER_16_8_9 = 21

ARKODE_VERNER_8_5_6 = 10

ARKODE_VERNER_9_5_6 = 18

ARKODE_ZONNEVELD_5_3_4 = 3

class sundials4py.arkode.ARKODE_LSRKMethodType(*values)

ARKODE_LSRK_RKC_2 = 0

ARKODE_LSRK_RKL_2 = 1

ARKODE_LSRK_SSP_10_4 = 4

ARKODE_LSRK_SSP_S_2 = 2

ARKODE_LSRK_SSP_S_3 = 3

class sundials4py.arkode.ARKODE_MRITableID(*values)

MRI coupling table IDs

ARKODE_IMEX_MRI_GARK3a = 206

ARKODE_IMEX_MRI_GARK3b = 207

ARKODE_IMEX_MRI_GARK4 = 208

ARKODE_IMEX_MRI_GARK_EULER = 216

ARKODE_IMEX_MRI_GARK_MIDPOINT = 218

ARKODE_IMEX_MRI_GARK_TRAPEZOIDAL = 217

ARKODE_IMEX_MRI_SR21 = 223

ARKODE_IMEX_MRI_SR32 = 224

ARKODE_IMEX_MRI_SR43 = 225

ARKODE_MAX_MRI_NUM = 225

ARKODE_MERK21 = 219

ARKODE_MERK32 = 220

ARKODE_MERK43 = 221

ARKODE_MERK54 = 222

ARKODE_MIN_MRI_NUM = 200

ARKODE_MIS_KW3 = 200

ARKODE_MRI_GARK_BACKWARD_EULER = 214

ARKODE_MRI_GARK_ERK22a = 211

ARKODE_MRI_GARK_ERK22b = 212

ARKODE_MRI_GARK_ERK33a = 201

ARKODE_MRI_GARK_ERK45a = 202

ARKODE_MRI_GARK_ESDIRK34a = 204

ARKODE_MRI_GARK_ESDIRK46a = 205

ARKODE_MRI_GARK_FORWARD_EULER = 209

ARKODE_MRI_GARK_IMPLICIT_MIDPOINT = 215

ARKODE_MRI_GARK_IRK21a = 203

ARKODE_MRI_GARK_RALSTON2 = 210

ARKODE_MRI_GARK_RALSTON3 = 213

ARKODE_MRI_NONE = -1

class sundials4py.arkode.ARKODE_SPRKMethodID(*values)

ARKODE_MAX_SPRK_NUM = 11

ARKODE_MIN_SPRK_NUM = 0

ARKODE_SPRK_CANDY_ROZMUS_4_4 = 6

ARKODE_SPRK_EULER_1_1 = 0

ARKODE_SPRK_LEAPFROG_2_2 = 1

ARKODE_SPRK_MCLACHLAN_2_2 = 4

ARKODE_SPRK_MCLACHLAN_3_3 = 5

ARKODE_SPRK_MCLACHLAN_4_4 = 7

ARKODE_SPRK_MCLACHLAN_5_6 = 8

ARKODE_SPRK_NONE = -1

ARKODE_SPRK_PSEUDO_LEAPFROG_2_2 = 2

ARKODE_SPRK_RUTH_3_3 = 3

ARKODE_SPRK_SOFRONIOU_10_36 = 11

ARKODE_SPRK_SUZUKI_UMENO_8_16 = 10

ARKODE_SPRK_YOSHIDA_6_8 = 9

class sundials4py.arkode.ARKODE_SplittingCoefficientsID(*values)

ARKODE_MAX_SPLITTING_NUM = 6

ARKODE_MIN_SPLITTING_NUM = 0

ARKODE_SPLITTING_BEST_2_2_2 = 2

ARKODE_SPLITTING_LIE_TROTTER_1_1_2 = 0

ARKODE_SPLITTING_NONE = -1

ARKODE_SPLITTING_RUTH_3_3_2 = 4

ARKODE_SPLITTING_STRANG_2_2_2 = 1

ARKODE_SPLITTING_SUZUKI_3_3_2 = 3

ARKODE_SPLITTING_YOSHIDA_4_4_2 = 5

ARKODE_SPLITTING_YOSHIDA_8_6_2 = 6

class sundials4py.arkode.ARKRelaxSolver(*values)

ARK_RELAX_BRENT = 0

ARK_RELAX_NEWTON = 1

class sundials4py.arkode.ARKodeButcherTableMem(*args, **kwargs)

class sundials4py.arkode.ARKodeSPRKTableMem(*args, **kwargs)

class sundials4py.arkode.ARKodeView

get

class sundials4py.arkode.MRISTEP_METHOD_TYPE(*values)

MRISTEP_EXPLICIT = 0

MRISTEP_IMEX = 2

MRISTEP_IMPLICIT = 1

MRISTEP_MERK = 3

MRISTEP_SR = 4

class sundials4py.arkode.MRIStepCouplingMem(*args, **kwargs)

class sundials4py.arkode.SplittingStepCoefficientsMem(*args, **kwargs)

class sundials4py.arkode._MRIStepInnerStepper

21.4.2. Functions

sundials4py.arkode.ARKStepCreate(fe: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, fi: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See ARKStepCreate().

sundials4py.arkode.ARKStepCreateAdjointStepper(arkode_mem: typing_extensions.CapsuleType, adj_fe: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, adj_fi: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, tf: float, sf: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → tuple[int, sundials4py.core.SUNAdjointStepper_]: See ARKStepCreateAdjointStepper().

sundials4py.arkode.ARKStepGetCurrentButcherTables(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.arkode.ARKodeButcherTableMem, sundials4py.arkode.ARKodeButcherTableMem]

Optional output functions

nb::rv_policy::reference

See ARKStepGetCurrentButcherTables().

sundials4py.arkode.ARKStepGetTimestepperStats(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int, int, int, int, int, int, int]: See ARKStepGetTimestepperStats().

sundials4py.arkode.ARKStepSetExplicit(arkode_mem: typing_extensions.CapsuleType) → int: See ARKStepSetExplicit().

sundials4py.arkode.ARKStepSetImEx(arkode_mem: typing_extensions.CapsuleType) → int: See ARKStepSetImEx().

sundials4py.arkode.ARKStepSetImplicit(arkode_mem: typing_extensions.CapsuleType) → int: See ARKStepSetImplicit().

sundials4py.arkode.ARKStepSetTableName(arkode_mem: typing_extensions.CapsuleType, itable: str, etable: str) → int: See ARKStepSetTableName().

sundials4py.arkode.ARKStepSetTableNum(arkode_mem: typing_extensions.CapsuleType, itable: sundials4py.arkode.ARKODE_DIRKTableID, etable: sundials4py.arkode.ARKODE_ERKTableID) → int: See ARKStepSetTableNum().

sundials4py.arkode.ARKStepSetTables(arkode_mem: typing_extensions.CapsuleType, q: int, p: int, Bi: sundials4py.arkode.ARKodeButcherTableMem, Be: sundials4py.arkode.ARKodeButcherTableMem) → int: See ARKStepSetTables().

sundials4py.arkode.ARKodeButcherTable_CheckARKOrder(B1: sundials4py.arkode.ARKodeButcherTableMem, B2: sundials4py.arkode.ARKodeButcherTableMem, outfile: sundials4py.core.FILE) → tuple[int, int, int]: See ARKodeButcherTable_CheckARKOrder().

sundials4py.arkode.ARKodeButcherTable_CheckOrder(B: sundials4py.arkode.ARKodeButcherTableMem, outfile: sundials4py.core.FILE) → tuple[int, int, int]: See ARKodeButcherTable_CheckOrder().

sundials4py.arkode.ARKodeButcherTable_Copy(B: sundials4py.arkode.ARKodeButcherTableMem) → sundials4py.arkode.ARKodeButcherTableMem: See ARKodeButcherTable_Copy().

sundials4py.arkode.ARKodeButcherTable_Create(s: int, q: int, p: int, c_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], A_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], b_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], d_1d: numpy.ndarray[dtype=float64, shape=(*), order='C']) → sundials4py.arkode.ARKodeButcherTableMem: See ARKodeButcherTable_Create().

sundials4py.arkode.ARKodeButcherTable_DIRKIDToName(imethod: sundials4py.arkode.ARKODE_DIRKTableID) → str: See ARKodeButcherTable_DIRKIDToName().

sundials4py.arkode.ARKodeButcherTable_ERKIDToName(emethod: sundials4py.arkode.ARKODE_ERKTableID) → str: See ARKodeButcherTable_ERKIDToName().

sundials4py.arkode.ARKodeButcherTable_IsStifflyAccurate(B: sundials4py.arkode.ARKodeButcherTableMem) → int: See ARKodeButcherTable_IsStifflyAccurate().

sundials4py.arkode.ARKodeButcherTable_LoadDIRK(imethod: sundials4py.arkode.ARKODE_DIRKTableID) → sundials4py.arkode.ARKodeButcherTableMem

Accessor routine to load built-in DIRK table

See ARKodeButcherTable_LoadDIRK().

sundials4py.arkode.ARKodeButcherTable_LoadDIRKByName(imethod: str) → sundials4py.arkode.ARKodeButcherTableMem

Accessor routine to load built-in DIRK table

See ARKodeButcherTable_LoadDIRKByName().

sundials4py.arkode.ARKodeButcherTable_LoadERK(emethod: sundials4py.arkode.ARKODE_ERKTableID) → sundials4py.arkode.ARKodeButcherTableMem

Accessor routine to load built-in ERK table

See ARKodeButcherTable_LoadERK().

sundials4py.arkode.ARKodeButcherTable_LoadERKByName(emethod: str) → sundials4py.arkode.ARKodeButcherTableMem: See ARKodeButcherTable_LoadERKByName().

sundials4py.arkode.ARKodeButcherTable_Write(B: sundials4py.arkode.ARKodeButcherTableMem, outfile: sundials4py.core.FILE) → None: See ARKodeButcherTable_Write().

sundials4py.arkode.ARKodeClearStopTime(arkode_mem: typing_extensions.CapsuleType) → int: See ARKodeClearStopTime().

sundials4py.arkode.ARKodeComputeState(arkode_mem: typing_extensions.CapsuleType, zcor: sundials4py.core._generic_N_Vector, z: sundials4py.core._generic_N_Vector) → int

Utility function to update/compute y based on zcor

See ARKodeComputeState().

sundials4py.arkode.ARKodeCreateMRIStepInnerStepper(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.arkode._MRIStepInnerStepper]

sundials4py.arkode.ARKodeCreateMRIStepInnerStepper(inner_arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.arkode._MRIStepInnerStepper]

Overloaded function.

ARKodeCreateMRIStepInnerStepper(arkode_mem: typing_extensions.CapsuleType) -> tuple[int, sundials4py.arkode._MRIStepInnerStepper]

Utility to wrap ARKODE as an MRIStepInnerStepper

ARKodeCreateMRIStepInnerStepper(inner_arkode_mem: typing_extensions.CapsuleType) -> tuple[int, sundials4py.arkode._MRIStepInnerStepper]

See ARKodeCreateMRIStepInnerStepper().

sundials4py.arkode.ARKodeCreateSUNStepper(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.core.SUNStepper_]

SUNStepper functions

See ARKodeCreateSUNStepper().

sundials4py.arkode.ARKodeEvolve(arkode_mem: typing_extensions.CapsuleType, tout: float, yout: sundials4py.core._generic_N_Vector, itask: int) → tuple[int, float]

Integrate the ODE over an interval in t

See ARKodeEvolve().

sundials4py.arkode.ARKodeGetAccumulatedError(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetAccumulatedError().

sundials4py.arkode.ARKodeGetActualInitStep(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetActualInitStep().

sundials4py.arkode.ARKodeGetCurrentGamma(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetCurrentGamma().

sundials4py.arkode.ARKodeGetCurrentMassMatrix(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.core._generic_SUNMatrix]

Optional output functions (non-identity mass matrices)

nb::rv_policy::reference

See ARKodeGetCurrentMassMatrix().

sundials4py.arkode.ARKodeGetCurrentState(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.core._generic_N_Vector]

nb::rv_policy::reference

See ARKodeGetCurrentState().

sundials4py.arkode.ARKodeGetCurrentStep(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetCurrentStep().

sundials4py.arkode.ARKodeGetCurrentTime(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetCurrentTime().

sundials4py.arkode.ARKodeGetDky(arkode_mem: typing_extensions.CapsuleType, t: float, k: int, dky: sundials4py.core._generic_N_Vector) → int

Computes the kth derivative of the y function at time t

See ARKodeGetDky().

sundials4py.arkode.ARKodeGetErrWeights(arkode_mem: typing_extensions.CapsuleType, eweight: sundials4py.core._generic_N_Vector) → int: See ARKodeGetErrWeights().

sundials4py.arkode.ARKodeGetEstLocalErrors(arkode_mem: typing_extensions.CapsuleType, ele: sundials4py.core._generic_N_Vector) → int: See ARKodeGetEstLocalErrors().

sundials4py.arkode.ARKodeGetJac(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.core._generic_SUNMatrix]

nb::rv_policy::reference

See ARKodeGetJac().

sundials4py.arkode.ARKodeGetJacNumSteps(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetJacNumSteps().

sundials4py.arkode.ARKodeGetJacTime(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetJacTime().

sundials4py.arkode.ARKodeGetLastLinFlag(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetLastLinFlag().

sundials4py.arkode.ARKodeGetLastMassFlag(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetLastMassFlag().

sundials4py.arkode.ARKodeGetLastStep(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetLastStep().

sundials4py.arkode.ARKodeGetLinReturnFlagName(flag: int) → str: See ARKodeGetLinReturnFlagName().

sundials4py.arkode.ARKodeGetNonlinSolvStats(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int, int]: See ARKodeGetNonlinSolvStats().

sundials4py.arkode.ARKodeGetNumAccSteps(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumAccSteps().

sundials4py.arkode.ARKodeGetNumConstrFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumConstrFails().

sundials4py.arkode.ARKodeGetNumErrTestFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumErrTestFails().

sundials4py.arkode.ARKodeGetNumExpSteps(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumExpSteps().

sundials4py.arkode.ARKodeGetNumGEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumGEvals().

sundials4py.arkode.ARKodeGetNumJTSetupEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumJTSetupEvals().

sundials4py.arkode.ARKodeGetNumJacEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumJacEvals().

sundials4py.arkode.ARKodeGetNumJtimesEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumJtimesEvals().

sundials4py.arkode.ARKodeGetNumLinConvFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumLinConvFails().

sundials4py.arkode.ARKodeGetNumLinIters(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumLinIters().

sundials4py.arkode.ARKodeGetNumLinRhsEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumLinRhsEvals().

sundials4py.arkode.ARKodeGetNumLinSolvSetups(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumLinSolvSetups().

sundials4py.arkode.ARKodeGetNumMTSetups(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMTSetups().

sundials4py.arkode.ARKodeGetNumMassConvFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassConvFails().

sundials4py.arkode.ARKodeGetNumMassIters(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassIters().

sundials4py.arkode.ARKodeGetNumMassMult(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassMult().

sundials4py.arkode.ARKodeGetNumMassMultSetups(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassMultSetups().

sundials4py.arkode.ARKodeGetNumMassPrecEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassPrecEvals().

sundials4py.arkode.ARKodeGetNumMassPrecSolves(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassPrecSolves().

sundials4py.arkode.ARKodeGetNumMassSetups(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassSetups().

sundials4py.arkode.ARKodeGetNumMassSolves(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumMassSolves().

sundials4py.arkode.ARKodeGetNumNonlinSolvConvFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumNonlinSolvConvFails().

sundials4py.arkode.ARKodeGetNumNonlinSolvIters(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumNonlinSolvIters().

sundials4py.arkode.ARKodeGetNumPrecEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumPrecEvals().

sundials4py.arkode.ARKodeGetNumPrecSolves(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumPrecSolves().

sundials4py.arkode.ARKodeGetNumRelaxBoundFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumRelaxBoundFails().

sundials4py.arkode.ARKodeGetNumRelaxFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumRelaxFails().

sundials4py.arkode.ARKodeGetNumRelaxFnEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumRelaxFnEvals().

sundials4py.arkode.ARKodeGetNumRelaxJacEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumRelaxJacEvals().

sundials4py.arkode.ARKodeGetNumRelaxSolveFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumRelaxSolveFails().

sundials4py.arkode.ARKodeGetNumRelaxSolveIters(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumRelaxSolveIters().

sundials4py.arkode.ARKodeGetNumRhsEvals(arkode_mem: typing_extensions.CapsuleType, partition_index: int) → tuple[int, int]: See ARKodeGetNumRhsEvals().

sundials4py.arkode.ARKodeGetNumStepAttempts(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumStepAttempts().

sundials4py.arkode.ARKodeGetNumStepSolveFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumStepSolveFails().

sundials4py.arkode.ARKodeGetNumSteps(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetNumSteps().

sundials4py.arkode.ARKodeGetResWeights(arkode_mem: typing_extensions.CapsuleType, rweight: sundials4py.core._generic_N_Vector) → int: See ARKodeGetResWeights().

sundials4py.arkode.ARKodeGetReturnFlagName(flag: int) → str: See ARKodeGetReturnFlagName().

sundials4py.arkode.ARKodeGetRootInfo(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See ARKodeGetRootInfo().

sundials4py.arkode.ARKodeGetStepDirection(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetStepDirection().

sundials4py.arkode.ARKodeGetStepStats(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int, float, float, float, float]: See ARKodeGetStepStats().

sundials4py.arkode.ARKodeGetTolScaleFactor(arkode_mem: typing_extensions.CapsuleType) → tuple[int, float]: See ARKodeGetTolScaleFactor().

sundials4py.arkode.ARKodePrintAllStats(arkode_mem: typing_extensions.CapsuleType, outfile: sundials4py.core.FILE, fmt: sundials4py.core.SUNOutputFormat) → int: See ARKodePrintAllStats().

sundials4py.arkode.ARKodePrintMem(arkode_mem: typing_extensions.CapsuleType, outfile: sundials4py.core.FILE) → None

Output the ARKODE memory structure (useful when debugging)

See ARKodePrintMem().

sundials4py.arkode.ARKodeResFtolerance(arkode_mem: typing_extensions.CapsuleType, efun: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeResFtolerance().

sundials4py.arkode.ARKodeResStolerance(arkode_mem: typing_extensions.CapsuleType, rabstol: float) → int: See ARKodeResStolerance().

sundials4py.arkode.ARKodeResVtolerance(arkode_mem: typing_extensions.CapsuleType, rabstol: sundials4py.core._generic_N_Vector) → int: See ARKodeResVtolerance().

sundials4py.arkode.ARKodeReset(arkode_mem: typing_extensions.CapsuleType, tR: float, yR: sundials4py.core._generic_N_Vector) → int: See ARKodeReset().

sundials4py.arkode.ARKodeResetAccumulatedError(arkode_mem: typing_extensions.CapsuleType) → int: See ARKodeResetAccumulatedError().

sundials4py.arkode.ARKodeResize(arkode_mem: typing_extensions.CapsuleType, y_new: sundials4py.core._generic_N_Vector, h_scale: float, t0: float, resize_fn: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeResize().

sundials4py.arkode.ARKodeRootInit(arkode_mem: typing_extensions.CapsuleType, nrtfn: int, root_fn: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, numpy.ndarray[dtype=float64, shape=(*), order='C'], typing_extensions.CapsuleType], int] | None) → int: See ARKodeRootInit().

sundials4py.arkode.ARKodeSPRKTable_Copy(that_sprk_storage: sundials4py.arkode.ARKodeSPRKTableMem) → sundials4py.arkode.ARKodeSPRKTableMem: See ARKodeSPRKTable_Copy().

sundials4py.arkode.ARKodeSPRKTable_Create(s: int, q: int, a_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], ahat_1d: numpy.ndarray[dtype=float64, shape=(*), order='C']) → sundials4py.arkode.ARKodeSPRKTableMem: See ARKodeSPRKTable_Create().

sundials4py.arkode.ARKodeSPRKTable_Load(id: sundials4py.arkode.ARKODE_SPRKMethodID) → sundials4py.arkode.ARKodeSPRKTableMem: See ARKodeSPRKTable_Load().

sundials4py.arkode.ARKodeSPRKTable_LoadByName(method: str) → sundials4py.arkode.ARKodeSPRKTableMem: See ARKodeSPRKTable_LoadByName().

sundials4py.arkode.ARKodeSPRKTable_ToButcher(sprk_storage: sundials4py.arkode.ARKodeSPRKTableMem) → tuple[int, sundials4py.arkode.ARKodeButcherTableMem, sundials4py.arkode.ARKodeButcherTableMem]: See ARKodeSPRKTable_ToButcher().

sundials4py.arkode.ARKodeSPRKTable_Write(sprk_table: sundials4py.arkode.ARKodeSPRKTableMem, outfile: sundials4py.core.FILE) → None: See ARKodeSPRKTable_Write().

sundials4py.arkode.ARKodeSStolerances(arkode_mem: typing_extensions.CapsuleType, reltol: float, abstol: float) → int: See ARKodeSStolerances().

sundials4py.arkode.ARKodeSVtolerances(arkode_mem: typing_extensions.CapsuleType, reltol: float, abstol: sundials4py.core._generic_N_Vector) → int: See ARKodeSVtolerances().

sundials4py.arkode.ARKodeSetAccumulatedErrorType(arkode_mem: typing_extensions.CapsuleType, accum_type: sundials4py.arkode.ARKAccumError) → int: See ARKodeSetAccumulatedErrorType().

sundials4py.arkode.ARKodeSetAdaptController(arkode_mem: typing_extensions.CapsuleType, C: sundials4py.core._generic_SUNAdaptController) → int: See ARKodeSetAdaptController().

sundials4py.arkode.ARKodeSetAdaptControllerByName(arkode_mem: typing_extensions.CapsuleType, cname: str) → int: See ARKodeSetAdaptControllerByName().

sundials4py.arkode.ARKodeSetAdaptivityAdjustment(arkode_mem: typing_extensions.CapsuleType, adjust: int) → int: See ARKodeSetAdaptivityAdjustment().

sundials4py.arkode.ARKodeSetAdjointCheckpointIndex(arkode_mem: typing_extensions.CapsuleType, step_index: int) → int: See ARKodeSetAdjointCheckpointIndex().

sundials4py.arkode.ARKodeSetAdjointCheckpointScheme(arkode_mem: typing_extensions.CapsuleType, checkpoint_scheme: sundials4py.core.SUNAdjointCheckpointScheme_) → int: See ARKodeSetAdjointCheckpointScheme().

sundials4py.arkode.ARKodeSetAutonomous(arkode_mem: typing_extensions.CapsuleType, autonomous: int) → int: See ARKodeSetAutonomous().

sundials4py.arkode.ARKodeSetCFLFraction(arkode_mem: typing_extensions.CapsuleType, cfl_frac: float) → int: See ARKodeSetCFLFraction().

sundials4py.arkode.ARKodeSetConstraints(arkode_mem: typing_extensions.CapsuleType, constraints: sundials4py.core._generic_N_Vector) → int: See ARKodeSetConstraints().

sundials4py.arkode.ARKodeSetDeduceImplicitRhs(arkode_mem: typing_extensions.CapsuleType, deduce: int) → int: See ARKodeSetDeduceImplicitRhs().

sundials4py.arkode.ARKodeSetDefaults(arkode_mem: typing_extensions.CapsuleType) → int: See ARKodeSetDefaults().

sundials4py.arkode.ARKodeSetDeltaGammaMax(arkode_mem: typing_extensions.CapsuleType, dgmax: float) → int: See ARKodeSetDeltaGammaMax().

sundials4py.arkode.ARKodeSetEpsLin(arkode_mem: typing_extensions.CapsuleType, eplifac: float) → int: See ARKodeSetEpsLin().

sundials4py.arkode.ARKodeSetErrorBias(arkode_mem: typing_extensions.CapsuleType, bias: float) → int: See ARKodeSetErrorBias().

sundials4py.arkode.ARKodeSetFixedStep(arkode_mem: typing_extensions.CapsuleType, hfixed: float) → int: See ARKodeSetFixedStep().

sundials4py.arkode.ARKodeSetFixedStepBounds(arkode_mem: typing_extensions.CapsuleType, lb: float, ub: float) → int: See ARKodeSetFixedStepBounds().

sundials4py.arkode.ARKodeSetInitStep(arkode_mem: typing_extensions.CapsuleType, hin: float) → int: See ARKodeSetInitStep().

sundials4py.arkode.ARKodeSetInterpolantDegree(arkode_mem: typing_extensions.CapsuleType, degree: int) → int: See ARKodeSetInterpolantDegree().

sundials4py.arkode.ARKodeSetInterpolantType(arkode_mem: typing_extensions.CapsuleType, itype: int) → int: See ARKodeSetInterpolantType().

sundials4py.arkode.ARKodeSetInterpolateStopTime(arkode_mem: typing_extensions.CapsuleType, interp: int) → int: See ARKodeSetInterpolateStopTime().

sundials4py.arkode.ARKodeSetJacEvalFrequency(arkode_mem: typing_extensions.CapsuleType, msbj: int) → int: See ARKodeSetJacEvalFrequency().

sundials4py.arkode.ARKodeSetJacFn(arkode_mem: typing_extensions.CapsuleType, jac: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_SUNMatrix, typing_extensions.CapsuleType, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector], int] | None) → int: See ARKodeSetJacFn().

sundials4py.arkode.ARKodeSetJacTimes(arkode_mem: typing_extensions.CapsuleType, jtsetup: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, jtimes: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType, sundials4py.core._generic_N_Vector], int] | None) → int: See ARKodeSetJacTimes().

sundials4py.arkode.ARKodeSetJacTimesRhsFn(arkode_mem: typing_extensions.CapsuleType, jtimesRhsFn: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetJacTimesRhsFn().

sundials4py.arkode.ARKodeSetLSNormFactor(arkode_mem: typing_extensions.CapsuleType, nrmfac: float) → int: See ARKodeSetLSNormFactor().

sundials4py.arkode.ARKodeSetLSetupFrequency(arkode_mem: typing_extensions.CapsuleType, msbp: int) → int: See ARKodeSetLSetupFrequency().

sundials4py.arkode.ARKodeSetLinSysFn(arkode_mem: typing_extensions.CapsuleType, linsys: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_SUNMatrix, sundials4py.core._generic_SUNMatrix, int, int, float, typing_extensions.CapsuleType, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector], int] | None) → int: See ARKodeSetLinSysFn().

sundials4py.arkode.ARKodeSetLinear(arkode_mem: typing_extensions.CapsuleType, timedepend: int) → int: See ARKodeSetLinear().

sundials4py.arkode.ARKodeSetLinearSolutionScaling(arkode_mem: typing_extensions.CapsuleType, onoff: int) → int: See ARKodeSetLinearSolutionScaling().

sundials4py.arkode.ARKodeSetLinearSolver(arkode_mem: typing_extensions.CapsuleType, LS: sundials4py.core._generic_SUNLinearSolver, A: sundials4py.core._generic_SUNMatrix | None = None) → int: See ARKodeSetLinearSolver().

sundials4py.arkode.ARKodeSetMassEpsLin(arkode_mem: typing_extensions.CapsuleType, eplifac: float) → int: See ARKodeSetMassEpsLin().

sundials4py.arkode.ARKodeSetMassFn(arkode_mem: typing_extensions.CapsuleType, mass: collections.abc.Callable[[float, sundials4py.core._generic_SUNMatrix, typing_extensions.CapsuleType, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector], int] | None) → int: See ARKodeSetMassFn().

sundials4py.arkode.ARKodeSetMassLSNormFactor(arkode_mem: typing_extensions.CapsuleType, nrmfac: float) → int: See ARKodeSetMassLSNormFactor().

sundials4py.arkode.ARKodeSetMassLinearSolver(arkode_mem: typing_extensions.CapsuleType, LS: sundials4py.core._generic_SUNLinearSolver, M: sundials4py.core._generic_SUNMatrix | None, time_dep: int) → int: See ARKodeSetMassLinearSolver().

sundials4py.arkode.ARKodeSetMassPreconditioner(arkode_mem: typing_extensions.CapsuleType, psetup: collections.abc.Callable[[float, typing_extensions.CapsuleType], int] | None, psolve: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, float, int, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetMassPreconditioner().

sundials4py.arkode.ARKodeSetMassTimes(ark_mem: typing_extensions.CapsuleType, msetup: collections.abc.Callable[[float, typing_extensions.CapsuleType], int] | None, mtimes: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, float, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetMassTimes().

sundials4py.arkode.ARKodeSetMaxCFailGrowth(arkode_mem: typing_extensions.CapsuleType, etacf: float) → int: See ARKodeSetMaxCFailGrowth().

sundials4py.arkode.ARKodeSetMaxConvFails(arkode_mem: typing_extensions.CapsuleType, maxncf: int) → int: See ARKodeSetMaxConvFails().

sundials4py.arkode.ARKodeSetMaxEFailGrowth(arkode_mem: typing_extensions.CapsuleType, etamxf: float) → int: See ARKodeSetMaxEFailGrowth().

sundials4py.arkode.ARKodeSetMaxErrTestFails(arkode_mem: typing_extensions.CapsuleType, maxnef: int) → int: See ARKodeSetMaxErrTestFails().

sundials4py.arkode.ARKodeSetMaxFirstGrowth(arkode_mem: typing_extensions.CapsuleType, etamx1: float) → int: See ARKodeSetMaxFirstGrowth().

sundials4py.arkode.ARKodeSetMaxGrowth(arkode_mem: typing_extensions.CapsuleType, mx_growth: float) → int: See ARKodeSetMaxGrowth().

sundials4py.arkode.ARKodeSetMaxHnilWarns(arkode_mem: typing_extensions.CapsuleType, mxhnil: int) → int: See ARKodeSetMaxHnilWarns().

sundials4py.arkode.ARKodeSetMaxNonlinIters(arkode_mem: typing_extensions.CapsuleType, maxcor: int) → int: See ARKodeSetMaxNonlinIters().

sundials4py.arkode.ARKodeSetMaxNumConstrFails(arkode_mem: typing_extensions.CapsuleType, maxfails: int) → int: See ARKodeSetMaxNumConstrFails().

sundials4py.arkode.ARKodeSetMaxNumSteps(arkode_mem: typing_extensions.CapsuleType, mxsteps: int) → int: See ARKodeSetMaxNumSteps().

sundials4py.arkode.ARKodeSetMaxStep(arkode_mem: typing_extensions.CapsuleType, hmax: float) → int: See ARKodeSetMaxStep().

sundials4py.arkode.ARKodeSetMinReduction(arkode_mem: typing_extensions.CapsuleType, eta_min: float) → int: See ARKodeSetMinReduction().

sundials4py.arkode.ARKodeSetMinStep(arkode_mem: typing_extensions.CapsuleType, hmin: float) → int: See ARKodeSetMinStep().

sundials4py.arkode.ARKodeSetNlsRhsFn(arkode_mem: typing_extensions.CapsuleType, nls_fi: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetNlsRhsFn().

sundials4py.arkode.ARKodeSetNoInactiveRootWarn(arkode_mem: typing_extensions.CapsuleType) → int: See ARKodeSetNoInactiveRootWarn().

sundials4py.arkode.ARKodeSetNonlinCRDown(arkode_mem: typing_extensions.CapsuleType, crdown: float) → int: See ARKodeSetNonlinCRDown().

sundials4py.arkode.ARKodeSetNonlinConvCoef(arkode_mem: typing_extensions.CapsuleType, nlscoef: float) → int: See ARKodeSetNonlinConvCoef().

sundials4py.arkode.ARKodeSetNonlinRDiv(arkode_mem: typing_extensions.CapsuleType, rdiv: float) → int: See ARKodeSetNonlinRDiv().

sundials4py.arkode.ARKodeSetNonlinear(arkode_mem: typing_extensions.CapsuleType) → int: See ARKodeSetNonlinear().

sundials4py.arkode.ARKodeSetNonlinearSolver(arkode_mem: typing_extensions.CapsuleType, NLS: sundials4py.core._generic_SUNNonlinearSolver) → int: See ARKodeSetNonlinearSolver().

sundials4py.arkode.ARKodeSetOptions(ark_mem: typing_extensions.CapsuleType, arkid: str, file_name: str, argc: int, args: collections.abc.Sequence[str]) → int: See ARKodeSetOptions().

sundials4py.arkode.ARKodeSetOrder(arkode_mem: typing_extensions.CapsuleType, maxord: int) → int: See ARKodeSetOrder().

sundials4py.arkode.ARKodeSetPostprocessStageFn(arkode_mem: typing_extensions.CapsuleType, postprocessstage: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetPostprocessStageFn().

sundials4py.arkode.ARKodeSetPostprocessStepFn(arkode_mem: typing_extensions.CapsuleType, postprocessstep: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetPostprocessStepFn().

sundials4py.arkode.ARKodeSetPreconditioner(arkode_mem: typing_extensions.CapsuleType, psetup: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, int, int, float, typing_extensions.CapsuleType], int] | None, psolve: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, float, float, int, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetPreconditioner().

sundials4py.arkode.ARKodeSetPredictorMethod(arkode_mem: typing_extensions.CapsuleType, method: int) → int: See ARKodeSetPredictorMethod().

sundials4py.arkode.ARKodeSetRelaxEtaFail(arkode_mem: typing_extensions.CapsuleType, eta_rf: float) → int: See ARKodeSetRelaxEtaFail().

sundials4py.arkode.ARKodeSetRelaxFn(arkode_mem: typing_extensions.CapsuleType, rfn: collections.abc.Callable[[sundials4py.core._generic_N_Vector, float, typing_extensions.CapsuleType], int] | None, rjacfn: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetRelaxFn().

sundials4py.arkode.ARKodeSetRelaxLowerBound(arkode_mem: typing_extensions.CapsuleType, lower: float) → int: See ARKodeSetRelaxLowerBound().

sundials4py.arkode.ARKodeSetRelaxMaxFails(arkode_mem: typing_extensions.CapsuleType, max_fails: int) → int: See ARKodeSetRelaxMaxFails().

sundials4py.arkode.ARKodeSetRelaxMaxIters(arkode_mem: typing_extensions.CapsuleType, max_iters: int) → int: See ARKodeSetRelaxMaxIters().

sundials4py.arkode.ARKodeSetRelaxResTol(arkode_mem: typing_extensions.CapsuleType, res_tol: float) → int: See ARKodeSetRelaxResTol().

sundials4py.arkode.ARKodeSetRelaxSolver(arkode_mem: typing_extensions.CapsuleType, solver: sundials4py.arkode.ARKRelaxSolver) → int: See ARKodeSetRelaxSolver().

sundials4py.arkode.ARKodeSetRelaxTol(arkode_mem: typing_extensions.CapsuleType, rel_tol: float, abs_tol: float) → int: See ARKodeSetRelaxTol().

sundials4py.arkode.ARKodeSetRelaxUpperBound(arkode_mem: typing_extensions.CapsuleType, upper: float) → int: See ARKodeSetRelaxUpperBound().

sundials4py.arkode.ARKodeSetRootDirection(arkode_mem: typing_extensions.CapsuleType, rootdir_1d: collections.abc.Sequence[int]) → int: See ARKodeSetRootDirection().

sundials4py.arkode.ARKodeSetSafetyFactor(arkode_mem: typing_extensions.CapsuleType, safety: float) → int: See ARKodeSetSafetyFactor().

sundials4py.arkode.ARKodeSetSmallNumEFails(arkode_mem: typing_extensions.CapsuleType, small_nef: int) → int: See ARKodeSetSmallNumEFails().

sundials4py.arkode.ARKodeSetStagePredictFn(arkode_mem: typing_extensions.CapsuleType, stagepredict: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeSetStagePredictFn().

sundials4py.arkode.ARKodeSetStepDirection(arkode_mem: typing_extensions.CapsuleType, stepdir: float) → int: See ARKodeSetStepDirection().

sundials4py.arkode.ARKodeSetStopTime(arkode_mem: typing_extensions.CapsuleType, tstop: float) → int: See ARKodeSetStopTime().

sundials4py.arkode.ARKodeSetUseCompensatedSums(arkode_mem: typing_extensions.CapsuleType, onoff: int) → int: See ARKodeSetUseCompensatedSums().

sundials4py.arkode.ARKodeWFtolerances(arkode_mem: typing_extensions.CapsuleType, efun: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int: See ARKodeWFtolerances().

sundials4py.arkode.ARKodeWriteParameters(arkode_mem: typing_extensions.CapsuleType, fp: sundials4py.core.FILE) → int: See ARKodeWriteParameters().

sundials4py.arkode.ERKStepCreate(rhs: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int], t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See ERKStepCreate().

sundials4py.arkode.ERKStepCreateAdjointStepper(arkode_mem: typing_extensions.CapsuleType, adj_f: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, tf: float, sf: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → tuple[int, sundials4py.core.SUNAdjointStepper_]: See ERKStepCreateAdjointStepper().

sundials4py.arkode.ERKStepGetCurrentButcherTable(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.arkode.ARKodeButcherTableMem]

Optional output functions

nb::rv_policy::reference

See ERKStepGetCurrentButcherTable().

sundials4py.arkode.ERKStepGetTimestepperStats(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int, int, int, int, int]

Grouped optional output functions

See ERKStepGetTimestepperStats().

sundials4py.arkode.ERKStepSetTable(arkode_mem: typing_extensions.CapsuleType, B: sundials4py.arkode.ARKodeButcherTableMem) → int: See ERKStepSetTable().

sundials4py.arkode.ERKStepSetTableName(arkode_mem: typing_extensions.CapsuleType, etable: str) → int: See ERKStepSetTableName().

sundials4py.arkode.ERKStepSetTableNum(arkode_mem: typing_extensions.CapsuleType, etable: sundials4py.arkode.ARKODE_ERKTableID) → int: See ERKStepSetTableNum().

sundials4py.arkode.ForcingStepCreate(stepper1: sundials4py.core.SUNStepper_, stepper2: sundials4py.core.SUNStepper_, t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See ForcingStepCreate().

sundials4py.arkode.ForcingStepGetNumEvolves(arkode_mem: typing_extensions.CapsuleType, partition: int) → tuple[int, int]: See ForcingStepGetNumEvolves().

sundials4py.arkode.ForcingStepReInit(arkode_mem: typing_extensions.CapsuleType, stepper1: sundials4py.core.SUNStepper_, stepper2: sundials4py.core.SUNStepper_, t0: float, y0: sundials4py.core._generic_N_Vector) → int: See ForcingStepReInit().

sundials4py.arkode.LSRKStepCreateSSP(rhs: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int], t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See LSRKStepCreateSSP().

sundials4py.arkode.LSRKStepCreateSTS(rhs: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int], t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See LSRKStepCreateSTS().

sundials4py.arkode.LSRKStepGetMaxNumStages(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See LSRKStepGetMaxNumStages().

sundials4py.arkode.LSRKStepGetNumDomEigEstIters(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See LSRKStepGetNumDomEigEstIters().

sundials4py.arkode.LSRKStepGetNumDomEigEstRhsEvals(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See LSRKStepGetNumDomEigEstRhsEvals().

sundials4py.arkode.LSRKStepGetNumDomEigUpdates(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See LSRKStepGetNumDomEigUpdates().

sundials4py.arkode.LSRKStepSetDomEigEstimator(arkode_mem: typing_extensions.CapsuleType, DEE: sundials4py.core.SUNDomEigEstimator_) → int: See LSRKStepSetDomEigEstimator().

sundials4py.arkode.LSRKStepSetDomEigFn(arkode_mem: typing_extensions.CapsuleType, eig_fn: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, float, float, typing_extensions.CapsuleType, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector], int]) → int: See LSRKStepSetDomEigFn().

sundials4py.arkode.LSRKStepSetDomEigFrequency(arkode_mem: typing_extensions.CapsuleType, nsteps: int) → int: See LSRKStepSetDomEigFrequency().

sundials4py.arkode.LSRKStepSetDomEigSafetyFactor(arkode_mem: typing_extensions.CapsuleType, dom_eig_safety: float) → int: See LSRKStepSetDomEigSafetyFactor().

sundials4py.arkode.LSRKStepSetMaxNumStages(arkode_mem: typing_extensions.CapsuleType, stage_max_limit: int) → int: See LSRKStepSetMaxNumStages().

sundials4py.arkode.LSRKStepSetNumDomEigEstInitPreprocessIters(arkode_mem: typing_extensions.CapsuleType, num_iters: int) → int: See LSRKStepSetNumDomEigEstInitPreprocessIters().

sundials4py.arkode.LSRKStepSetNumDomEigEstPreprocessIters(arkode_mem: typing_extensions.CapsuleType, num_iters: int) → int: See LSRKStepSetNumDomEigEstPreprocessIters().

sundials4py.arkode.LSRKStepSetNumSSPStages(arkode_mem: typing_extensions.CapsuleType, num_of_stages: int) → int: See LSRKStepSetNumSSPStages().

sundials4py.arkode.LSRKStepSetSSPMethod(arkode_mem: typing_extensions.CapsuleType, method: sundials4py.arkode.ARKODE_LSRKMethodType) → int: See LSRKStepSetSSPMethod().

sundials4py.arkode.LSRKStepSetSSPMethodByName(arkode_mem: typing_extensions.CapsuleType, emethod: str) → int: See LSRKStepSetSSPMethodByName().

sundials4py.arkode.LSRKStepSetSTSMethod(arkode_mem: typing_extensions.CapsuleType, method: sundials4py.arkode.ARKODE_LSRKMethodType) → int: See LSRKStepSetSTSMethod().

sundials4py.arkode.LSRKStepSetSTSMethodByName(arkode_mem: typing_extensions.CapsuleType, emethod: str) → int: See LSRKStepSetSTSMethodByName().

sundials4py.arkode.MRIStepCoupling_Copy(MRIC: sundials4py.arkode.MRIStepCouplingMem) → sundials4py.arkode.MRIStepCouplingMem: See MRIStepCoupling_Copy().

sundials4py.arkode.MRIStepCoupling_Create(nmat: int, stages: int, q: int, p: int, W_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], G_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], c_1d: numpy.ndarray[dtype=float64, shape=(*), order='C']) → sundials4py.arkode.MRIStepCouplingMem: See MRIStepCoupling_Create().

sundials4py.arkode.MRIStepCoupling_LoadTable(method: sundials4py.arkode.ARKODE_MRITableID) → sundials4py.arkode.MRIStepCouplingMem

Accessor routine to load built-in MRI table

See MRIStepCoupling_LoadTable().

sundials4py.arkode.MRIStepCoupling_LoadTableByName(method: str) → sundials4py.arkode.MRIStepCouplingMem

Accessor routine to load built-in MRI table from string

See MRIStepCoupling_LoadTableByName().

sundials4py.arkode.MRIStepCoupling_MIStoMRI(B: sundials4py.arkode.ARKodeButcherTableMem, q: int, p: int) → sundials4py.arkode.MRIStepCouplingMem: See MRIStepCoupling_MIStoMRI().

sundials4py.arkode.MRIStepCoupling_Write(MRIC: sundials4py.arkode.MRIStepCouplingMem, outfile: sundials4py.core.FILE) → None: See MRIStepCoupling_Write().

sundials4py.arkode.MRIStepCreate(fse: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, fsi: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, t0: float, y0: sundials4py.core._generic_N_Vector, inner_stepper: sundials4py.arkode._MRIStepInnerStepper, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See MRIStepCreate().

sundials4py.arkode.MRIStepGetCurrentCoupling(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.arkode.MRIStepCouplingMem]

Optional output functions

nb::rv_policy::reference

See MRIStepGetCurrentCoupling().

sundials4py.arkode.MRIStepGetLastInnerStepFlag(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See MRIStepGetLastInnerStepFlag().

sundials4py.arkode.MRIStepGetNumInnerStepperFails(arkode_mem: typing_extensions.CapsuleType) → tuple[int, int]: See MRIStepGetNumInnerStepperFails().

sundials4py.arkode.MRIStepInnerStepper_AddForcing(stepper: sundials4py.arkode._MRIStepInnerStepper, t: float, f: sundials4py.core._generic_N_Vector) → int: See MRIStepInnerStepper_AddForcing().

sundials4py.arkode.MRIStepInnerStepper_Create(sunctx: sundials4py.core.SUNContext_) → tuple[int, sundials4py.arkode._MRIStepInnerStepper]: See MRIStepInnerStepper_Create().

sundials4py.arkode.MRIStepInnerStepper_CreateFromSUNStepper(stepper: sundials4py.core.SUNStepper_) → tuple[int, sundials4py.arkode._MRIStepInnerStepper]: See MRIStepInnerStepper_CreateFromSUNStepper().

sundials4py.arkode.MRIStepInnerStepper_GetForcingData(arg: sundials4py.arkode._MRIStepInnerStepper, /) → tuple[int, float, float, list[sundials4py.core._generic_N_Vector], int]: See MRIStepInnerStepper_GetForcingData().

sundials4py.arkode.MRIStepSetCoupling(arkode_mem: typing_extensions.CapsuleType, MRIC: sundials4py.arkode.MRIStepCouplingMem) → int: See MRIStepSetCoupling().

sundials4py.arkode.SPRKStepCreate(f1: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int], f2: collections.abc.Callable[[float, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int], t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See SPRKStepCreate().

sundials4py.arkode.SPRKStepGetCurrentMethod(arkode_mem: typing_extensions.CapsuleType) → tuple[int, sundials4py.arkode.ARKodeSPRKTableMem]

Optional output functions

nb::rv_policy::reference

See SPRKStepGetCurrentMethod().

sundials4py.arkode.SPRKStepSetMethod(arkode_mem: typing_extensions.CapsuleType, sprk_storage: sundials4py.arkode.ARKodeSPRKTableMem) → int: See SPRKStepSetMethod().

sundials4py.arkode.SPRKStepSetMethodName(arkode_mem: typing_extensions.CapsuleType, method: str) → int: See SPRKStepSetMethodName().

sundials4py.arkode.SplittingStepCoefficients_Copy(coefficients: sundials4py.arkode.SplittingStepCoefficientsMem) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_Copy().

sundials4py.arkode.SplittingStepCoefficients_Create(sequential_methods: int, stages: int, partitions: int, order: int, alpha_1d: numpy.ndarray[dtype=float64, shape=(*), order='C'], beta_1d: numpy.ndarray[dtype=float64, shape=(*), order='C']) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_Create().

sundials4py.arkode.SplittingStepCoefficients_IDToName(id: sundials4py.arkode.ARKODE_SplittingCoefficientsID) → str: See SplittingStepCoefficients_IDToName().

sundials4py.arkode.SplittingStepCoefficients_LieTrotter(partitions: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_LieTrotter().

sundials4py.arkode.SplittingStepCoefficients_LoadCoefficients(id: sundials4py.arkode.ARKODE_SplittingCoefficientsID) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_LoadCoefficients().

sundials4py.arkode.SplittingStepCoefficients_LoadCoefficientsByName(name: str) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_LoadCoefficientsByName().

sundials4py.arkode.SplittingStepCoefficients_Parallel(partitions: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_Parallel().

sundials4py.arkode.SplittingStepCoefficients_Strang(partitions: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_Strang().

sundials4py.arkode.SplittingStepCoefficients_SuzukiFractal(partitions: int, order: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_SuzukiFractal().

sundials4py.arkode.SplittingStepCoefficients_SymmetricParallel(partitions: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_SymmetricParallel().

sundials4py.arkode.SplittingStepCoefficients_ThirdOrderSuzuki(partitions: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_ThirdOrderSuzuki().

sundials4py.arkode.SplittingStepCoefficients_TripleJump(partitions: int, order: int) → sundials4py.arkode.SplittingStepCoefficientsMem: See SplittingStepCoefficients_TripleJump().

sundials4py.arkode.SplittingStepCoefficients_Write(coefficients: sundials4py.arkode.SplittingStepCoefficientsMem, outfile: sundials4py.core.FILE) → None: See SplittingStepCoefficients_Write().

sundials4py.arkode.SplittingStepCreate(steppers: collections.abc.Sequence[sundials4py.core.SUNStepper_], partitions: int, t0: float, y0: sundials4py.core._generic_N_Vector, sunctx: sundials4py.core.SUNContext_) → sundials4py.arkode.ARKodeView: See SplittingStepCreate().

sundials4py.arkode.SplittingStepGetNumEvolves(arkode_mem: typing_extensions.CapsuleType, partition: int) → tuple[int, int]: See SplittingStepGetNumEvolves().

sundials4py.arkode.SplittingStepReInit(arkode_mem: typing_extensions.CapsuleType, steppers: collections.abc.Sequence[sundials4py.core.SUNStepper_], partitions: int, t0: float, y0: sundials4py.core._generic_N_Vector) → int: See SplittingStepReInit().

sundials4py.arkode.SplittingStepSetCoefficients(arkode_mem: typing_extensions.CapsuleType, coefficients: sundials4py.arkode.SplittingStepCoefficientsMem) → int: See SplittingStepSetCoefficients().