kinsol_spils.h File Reference

#include <sundials/sundials_iterative.h>
#include <sundials/sundials_nvector.h>

Go to the source code of this file.

Defines
#define	KINSPILS_SUCCESS   0
#define	KINSPILS_MEM_NULL   -1
#define	KINSPILS_LMEM_NULL   -2
#define	KINSPILS_ILL_INPUT   -3
#define	KINSPILS_MEM_FAIL   -4
#define	KINSPILS_MAXL   10
Typedefs
typedef int(*	KINSpilsPrecSetupFn )(N_Vector uu, N_Vector uscale, N_Vector fval, N_Vector fscale, void *P_data, N_Vector vtemp1, N_Vector vtemp2)
typedef int(*	KINSpilsPrecSolveFn )(N_Vector uu, N_Vector uscale, N_Vector fval, N_Vector fscale, N_Vector vv, void *P_data, N_Vector vtemp)
typedef int(*	KINSpilsJacTimesVecFn )(N_Vector v, N_Vector Jv, N_Vector uu, booleantype *new_uu, void *J_data)
Functions
SUNDIALS_EXPORT int	KINSpilsSetMaxRestarts (void *kinmem, int maxrs)
SUNDIALS_EXPORT int	KINSpilsSetPreconditioner (void *kinmem, KINSpilsPrecSetupFn pset, KINSpilsPrecSolveFn psolve, void *P_data)
SUNDIALS_EXPORT int	KINSpilsSetJacTimesVecFn (void *kinmem, KINSpilsJacTimesVecFn jtimes, void *J_data)
SUNDIALS_EXPORT int	KINSpilsGetWorkSpace (void *kinmem, long int *lenrwSG, long int *leniwSG)
SUNDIALS_EXPORT int	KINSpilsGetNumPrecEvals (void *kinmem, long int *npevals)
SUNDIALS_EXPORT int	KINSpilsGetNumPrecSolves (void *kinmem, long int *npsolves)
SUNDIALS_EXPORT int	KINSpilsGetNumLinIters (void *kinmem, long int *nliters)
SUNDIALS_EXPORT int	KINSpilsGetNumConvFails (void *kinmem, long int *nlcfails)
SUNDIALS_EXPORT int	KINSpilsGetNumJtimesEvals (void *kinmem, long int *njvevals)
SUNDIALS_EXPORT int	KINSpilsGetNumFuncEvals (void *kinmem, long int *nfevalsS)
SUNDIALS_EXPORT int	KINSpilsGetLastFlag (void *kinmem, int *flag)
SUNDIALS_EXPORT char *	KINSpilsGetReturnFlagName (int flag)

---

Define Documentation

#define KINSPILS_ILL_INPUT   -3

#define KINSPILS_LMEM_NULL   -2

#define KINSPILS_MAXL   10

#define KINSPILS_MEM_FAIL   -4

#define KINSPILS_MEM_NULL   -1

#define KINSPILS_SUCCESS   0

---

Typedef Documentation

typedef int(* KINSpilsJacTimesVecFn)(N_Vector v, N_Vector Jv, N_Vector uu, booleantype *new_uu, void *J_data)

typedef int(* KINSpilsPrecSetupFn)(N_Vector uu, N_Vector uscale, N_Vector fval, N_Vector fscale, void *P_data, N_Vector vtemp1, N_Vector vtemp2)

typedef int(* KINSpilsPrecSolveFn)(N_Vector uu, N_Vector uscale, N_Vector fval, N_Vector fscale, N_Vector vv, void *P_data, N_Vector vtemp)

---

Function Documentation

SUNDIALS_EXPORT int KINSpilsGetLastFlag	(	void *	kinmem,
		int *	flag
	)

SUNDIALS_EXPORT int KINSpilsGetNumConvFails	(	void *	kinmem,
		long int *	nlcfails
	)

SUNDIALS_EXPORT int KINSpilsGetNumFuncEvals	(	void *	kinmem,
		long int *	nfevalsS
	)

SUNDIALS_EXPORT int KINSpilsGetNumJtimesEvals	(	void *	kinmem,
		long int *	njvevals
	)

SUNDIALS_EXPORT int KINSpilsGetNumLinIters	(	void *	kinmem,
		long int *	nliters
	)

SUNDIALS_EXPORT int KINSpilsGetNumPrecEvals	(	void *	kinmem,
		long int *	npevals
	)

SUNDIALS_EXPORT int KINSpilsGetNumPrecSolves	(	void *	kinmem,
		long int *	npsolves
	)

SUNDIALS_EXPORT char* KINSpilsGetReturnFlagName

(

int

flag

)

SUNDIALS_EXPORT int KINSpilsGetWorkSpace	(	void *	kinmem,
		long int *	lenrwSG,
		long int *	leniwSG
	)

SUNDIALS_EXPORT int KINSpilsSetJacTimesVecFn	(	void *	kinmem,
		KINSpilsJacTimesVecFn	jtimes,
		void *	J_data
	)

SUNDIALS_EXPORT int KINSpilsSetMaxRestarts	(	void *	kinmem,
		int	maxrs
	)

SUNDIALS_EXPORT int KINSpilsSetPreconditioner	(	void *	kinmem,
		KINSpilsPrecSetupFn	pset,
		KINSpilsPrecSolveFn	psolve,
		void *	P_data
	)