21.7. kinsol Submodule

21.7.1. Classes

A submodule of ‘sundials4py’

class sundials4py.kinsol.KINView

get

21.7.2. Functions

sundials4py.kinsol.KINCreate(sunctx: sundials4py.core.SUNContext_) → sundials4py.kinsol.KINView

See KINCreate().

sundials4py.kinsol.KINGetFuncNorm(kinmem: typing_extensions.CapsuleType) → tuple[int, float]

See KINGetFuncNorm().

sundials4py.kinsol.KINGetJac(kinmem: typing_extensions.CapsuleType) → tuple[int, sundials4py.core._generic_SUNMatrix]

nb::rv_policy::reference

See KINGetJac().

sundials4py.kinsol.KINGetJacNumIters(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetJacNumIters().

sundials4py.kinsol.KINGetLastLinFlag(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetLastLinFlag().

sundials4py.kinsol.KINGetLinReturnFlagName(flag: int) → str

See KINGetLinReturnFlagName().

sundials4py.kinsol.KINGetNumBacktrackOps(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumBacktrackOps().

sundials4py.kinsol.KINGetNumBetaCondFails(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumBetaCondFails().

sundials4py.kinsol.KINGetNumFuncEvals(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumFuncEvals().

sundials4py.kinsol.KINGetNumJacEvals(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumJacEvals().

sundials4py.kinsol.KINGetNumJtimesEvals(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumJtimesEvals().

sundials4py.kinsol.KINGetNumLinConvFails(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumLinConvFails().

sundials4py.kinsol.KINGetNumLinFuncEvals(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumLinFuncEvals().

sundials4py.kinsol.KINGetNumLinIters(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumLinIters().

sundials4py.kinsol.KINGetNumNonlinSolvIters(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumNonlinSolvIters().

sundials4py.kinsol.KINGetNumPrecEvals(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumPrecEvals().

sundials4py.kinsol.KINGetNumPrecSolves(kinmem: typing_extensions.CapsuleType) → tuple[int, int]

See KINGetNumPrecSolves().

sundials4py.kinsol.KINGetReturnFlagName(flag: int) → str

See KINGetReturnFlagName().

sundials4py.kinsol.KINGetStepLength(kinmem: typing_extensions.CapsuleType) → tuple[int, float]

See KINGetStepLength().

sundials4py.kinsol.KINInit(kin_mem: typing_extensions.CapsuleType, sysfn: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int], tmpl: sundials4py.core._generic_N_Vector) → int

See KINInit().

sundials4py.kinsol.KINPrintAllStats(kinmem: typing_extensions.CapsuleType, outfile: sundials4py.core.FILE, fmt: sundials4py.core.SUNOutputFormat) → int

See KINPrintAllStats().

sundials4py.kinsol.KINSetConstraints(kinmem: typing_extensions.CapsuleType, constraints: sundials4py.core._generic_N_Vector) → int

See KINSetConstraints().

sundials4py.kinsol.KINSetDamping(kinmem: typing_extensions.CapsuleType, beta: float) → int

See KINSetDamping().

sundials4py.kinsol.KINSetDampingAA(kinmem: typing_extensions.CapsuleType, beta: float) → int

See KINSetDampingAA().

sundials4py.kinsol.KINSetDampingFn(kin_mem: typing_extensions.CapsuleType, damping_fn: collections.abc.Callable[[int, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, numpy.ndarray[dtype=float64, shape=(*), order='C'], int, typing_extensions.CapsuleType], tuple[int, float]] | None) → int

See KINSetDampingFn().

sundials4py.kinsol.KINSetDelayAA(kinmem: typing_extensions.CapsuleType, delay: int) → int

See KINSetDelayAA().

sundials4py.kinsol.KINSetDepthFn(kin_mem: typing_extensions.CapsuleType, depth_fn: collections.abc.Callable[[int, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, collections.abc.Sequence[sundials4py.core._generic_N_Vector], numpy.ndarray[dtype=float64, shape=(*), order='C'], int, typing_extensions.CapsuleType, collections.abc.Sequence[int]], tuple[int, int]] | None) → int

See KINSetDepthFn().

sundials4py.kinsol.KINSetEtaConstValue(kinmem: typing_extensions.CapsuleType, eta: float) → int

See KINSetEtaConstValue().

sundials4py.kinsol.KINSetEtaForm(kinmem: typing_extensions.CapsuleType, etachoice: int) → int

See KINSetEtaForm().

sundials4py.kinsol.KINSetEtaParams(kinmem: typing_extensions.CapsuleType, egamma: float, ealpha: float) → int

See KINSetEtaParams().

sundials4py.kinsol.KINSetFuncNormTol(kinmem: typing_extensions.CapsuleType, fnormtol: float) → int

See KINSetFuncNormTol().

sundials4py.kinsol.KINSetJacFn(kin_mem: typing_extensions.CapsuleType, jac: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int

See KINSetJacFn().

sundials4py.kinsol.KINSetJacTimesVecFn(kin_mem: typing_extensions.CapsuleType, jtimes: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], tuple[int, int]] | None) → int

See KINSetJacTimesVecFn().

sundials4py.kinsol.KINSetJacTimesVecSysFn(kin_mem: typing_extensions.CapsuleType, jtvSysFn: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int

See KINSetJacTimesVecSysFn().

sundials4py.kinsol.KINSetLinearSolver(kinmem: typing_extensions.CapsuleType, LS: sundials4py.core._generic_SUNLinearSolver, A: sundials4py.core._generic_SUNMatrix | None = None) → int

See KINSetLinearSolver().

sundials4py.kinsol.KINSetMAA(kinmem: typing_extensions.CapsuleType, maa: int) → int

See KINSetMAA().

sundials4py.kinsol.KINSetMaxBetaFails(kinmem: typing_extensions.CapsuleType, mxnbcf: int) → int

See KINSetMaxBetaFails().

sundials4py.kinsol.KINSetMaxNewtonStep(kinmem: typing_extensions.CapsuleType, mxnewtstep: float) → int

See KINSetMaxNewtonStep().

sundials4py.kinsol.KINSetMaxSetupCalls(kinmem: typing_extensions.CapsuleType, msbset: int) → int

See KINSetMaxSetupCalls().

sundials4py.kinsol.KINSetMaxSubSetupCalls(kinmem: typing_extensions.CapsuleType, msbsetsub: int) → int

See KINSetMaxSubSetupCalls().

sundials4py.kinsol.KINSetNoInitSetup(kinmem: typing_extensions.CapsuleType, noInitSetup: int) → int

See KINSetNoInitSetup().

sundials4py.kinsol.KINSetNoMinEps(kinmem: typing_extensions.CapsuleType, noMinEps: int) → int

See KINSetNoMinEps().

sundials4py.kinsol.KINSetNoResMon(kinmem: typing_extensions.CapsuleType, noNNIResMon: int) → int

See KINSetNoResMon().

sundials4py.kinsol.KINSetNumMaxIters(kinmem: typing_extensions.CapsuleType, mxiter: int) → int

See KINSetNumMaxIters().

sundials4py.kinsol.KINSetOptions(kin_mem: typing_extensions.CapsuleType, kinid: str, file_name: str, argc: int, args: collections.abc.Sequence[str]) → int

See KINSetOptions().

sundials4py.kinsol.KINSetOrthAA(kinmem: typing_extensions.CapsuleType, orthaa: int) → int

See KINSetOrthAA().

sundials4py.kinsol.KINSetPreconditioner(kin_mem: typing_extensions.CapsuleType, psetup: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None, psolve: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int] | None) → int

See KINSetPreconditioner().

sundials4py.kinsol.KINSetRelErrFunc(kinmem: typing_extensions.CapsuleType, relfunc: float) → int

See KINSetRelErrFunc().

sundials4py.kinsol.KINSetResMonConstValue(kinmem: typing_extensions.CapsuleType, omegaconst: float) → int

See KINSetResMonConstValue().

sundials4py.kinsol.KINSetResMonParams(kinmem: typing_extensions.CapsuleType, omegamin: float, omegamax: float) → int

See KINSetResMonParams().

sundials4py.kinsol.KINSetReturnNewest(kinmem: typing_extensions.CapsuleType, ret_newest: int) → int

See KINSetReturnNewest().

sundials4py.kinsol.KINSetScaledStepTol(kinmem: typing_extensions.CapsuleType, scsteptol: float) → int

See KINSetScaledStepTol().

sundials4py.kinsol.KINSetSysFunc(kin_mem: typing_extensions.CapsuleType, sysfn: collections.abc.Callable[[sundials4py.core._generic_N_Vector, sundials4py.core._generic_N_Vector, typing_extensions.CapsuleType], int]) → int

See KINSetSysFunc().

sundials4py.kinsol.KINSetUserData(kinmem: typing_extensions.CapsuleType, user_data: typing_extensions.CapsuleType) → int

See KINSetUserData().

sundials4py.kinsol.KINSol(kinmem: typing_extensions.CapsuleType, uu: sundials4py.core._generic_N_Vector, strategy: int, u_scale: sundials4py.core._generic_N_Vector, f_scale: sundials4py.core._generic_N_Vector) → int

Solver function

See KINSol().