cvodes_spils.h File Reference

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

Go to the source code of this file.

Defines
#define	CVSPILS_SUCCESS   0
#define	CVSPILS_MEM_NULL   -1
#define	CVSPILS_LMEM_NULL   -2
#define	CVSPILS_ILL_INPUT   -3
#define	CVSPILS_MEM_FAIL   -4
#define	CVSPILS_ADJMEM_NULL   -101
#define	CVSPILS_LMEMB_NULL   -102
#define	CVSPILS_MAXL   5
#define	CVSPILS_MSBPRE   50
#define	CVSPILS_DGMAX   RCONST(0.2)
#define	CVSPILS_DELT   RCONST(0.05)
Typedefs
typedef int(*	CVSpilsPrecSetupFn )(realtype t, N_Vector y, N_Vector fy, booleantype jok, booleantype *jcurPtr, realtype gamma, void *P_data, N_Vector tmp1, N_Vector tmp2, N_Vector tmp3)
typedef int(*	CVSpilsPrecSolveFn )(realtype t, N_Vector y, N_Vector fy, N_Vector r, N_Vector z, realtype gamma, realtype delta, int lr, void *P_data, N_Vector tmp)
typedef int(*	CVSpilsJacTimesVecFn )(N_Vector v, N_Vector Jv, realtype t, N_Vector y, N_Vector fy, void *jac_data, N_Vector tmp)
typedef int(*	CVSpilsPrecSetupFnB )(realtype t, N_Vector y, N_Vector yB, N_Vector fyB, booleantype jokB, booleantype *jcurPtrB, realtype gammaB, void *P_dataB, N_Vector tmp1B, N_Vector tmp2B, N_Vector tmp3B)
typedef int(*	CVSpilsPrecSolveFnB )(realtype t, N_Vector y, N_Vector yB, N_Vector fyB, N_Vector rB, N_Vector zB, realtype gammaB, realtype deltaB, int lrB, void *P_dataB, N_Vector tmpB)
typedef int(*	CVSpilsJacTimesVecFnB )(N_Vector vB, N_Vector JvB, realtype t, N_Vector y, N_Vector yB, N_Vector fyB, void *jac_dataB, N_Vector tmpB)
Functions
SUNDIALS_EXPORT int	CVSpilsSetPrecType (void *cvode_mem, int pretype)
SUNDIALS_EXPORT int	CVSpilsSetGSType (void *cvode_mem, int gstype)
SUNDIALS_EXPORT int	CVSpilsSetMaxl (void *cvode_mem, int maxl)
SUNDIALS_EXPORT int	CVSpilsSetDelt (void *cvode_mem, realtype delt)
SUNDIALS_EXPORT int	CVSpilsSetPreconditioner (void *cvode_mem, CVSpilsPrecSetupFn pset, CVSpilsPrecSolveFn psolve, void *P_data)
SUNDIALS_EXPORT int	CVSpilsSetJacTimesVecFn (void *cvode_mem, CVSpilsJacTimesVecFn jtimes, void *jac_data)
SUNDIALS_EXPORT int	CVSpilsGetWorkSpace (void *cvode_mem, long int *lenrwLS, long int *leniwLS)
SUNDIALS_EXPORT int	CVSpilsGetNumPrecEvals (void *cvode_mem, long int *npevals)
SUNDIALS_EXPORT int	CVSpilsGetNumPrecSolves (void *cvode_mem, long int *npsolves)
SUNDIALS_EXPORT int	CVSpilsGetNumLinIters (void *cvode_mem, long int *nliters)
SUNDIALS_EXPORT int	CVSpilsGetNumConvFails (void *cvode_mem, long int *nlcfails)
SUNDIALS_EXPORT int	CVSpilsGetNumJtimesEvals (void *cvode_mem, long int *njvevals)
SUNDIALS_EXPORT int	CVSpilsGetNumRhsEvals (void *cvode_mem, long int *nfevalsLS)
SUNDIALS_EXPORT int	CVSpilsGetLastFlag (void *cvode_mem, int *flag)
SUNDIALS_EXPORT char *	CVSpilsGetReturnFlagName (int flag)
SUNDIALS_EXPORT int	CVSpilsSetPrecTypeB (void *cvadj_mem, int pretypeB)
SUNDIALS_EXPORT int	CVSpilsSetGSTypeB (void *cvadj_mem, int gstypeB)
SUNDIALS_EXPORT int	CVSpilsSetDeltB (void *cvadj_mem, realtype deltB)
SUNDIALS_EXPORT int	CVSpilsSetMaxlB (void *cvadj_mem, int maxlB)
SUNDIALS_EXPORT int	CVSpilsSetPreconditionerB (void *cvadj_mem, CVSpilsPrecSetupFnB psetB, CVSpilsPrecSolveFnB psolveB, void *P_dataB)
SUNDIALS_EXPORT int	CVSpilsSetJacTimesVecFnB (void *cvadj_mem, CVSpilsJacTimesVecFnB jtimesB, void *jac_dataB)

---

Define Documentation

#define CVSPILS_ADJMEM_NULL   -101

#define CVSPILS_DELT   RCONST(0.05)

#define CVSPILS_DGMAX   RCONST(0.2)

#define CVSPILS_ILL_INPUT   -3

#define CVSPILS_LMEM_NULL   -2

#define CVSPILS_LMEMB_NULL   -102

#define CVSPILS_MAXL   5

#define CVSPILS_MEM_FAIL   -4

#define CVSPILS_MEM_NULL   -1

#define CVSPILS_MSBPRE   50

#define CVSPILS_SUCCESS   0

---

Typedef Documentation

typedef int(* CVSpilsJacTimesVecFn)(N_Vector v, N_Vector Jv, realtype t, N_Vector y, N_Vector fy, void *jac_data, N_Vector tmp)

typedef int(* CVSpilsJacTimesVecFnB)(N_Vector vB, N_Vector JvB, realtype t, N_Vector y, N_Vector yB, N_Vector fyB, void *jac_dataB, N_Vector tmpB)

typedef int(* CVSpilsPrecSetupFn)(realtype t, N_Vector y, N_Vector fy, booleantype jok, booleantype *jcurPtr, realtype gamma, void *P_data, N_Vector tmp1, N_Vector tmp2, N_Vector tmp3)

typedef int(* CVSpilsPrecSetupFnB)(realtype t, N_Vector y, N_Vector yB, N_Vector fyB, booleantype jokB, booleantype *jcurPtrB, realtype gammaB, void *P_dataB, N_Vector tmp1B, N_Vector tmp2B, N_Vector tmp3B)

typedef int(* CVSpilsPrecSolveFn)(realtype t, N_Vector y, N_Vector fy, N_Vector r, N_Vector z, realtype gamma, realtype delta, int lr, void *P_data, N_Vector tmp)

typedef int(* CVSpilsPrecSolveFnB)(realtype t, N_Vector y, N_Vector yB, N_Vector fyB, N_Vector rB, N_Vector zB, realtype gammaB, realtype deltaB, int lrB, void *P_dataB, N_Vector tmpB)

---

Function Documentation

SUNDIALS_EXPORT int CVSpilsGetLastFlag	(	void *	cvode_mem,
		int *	flag
	)

SUNDIALS_EXPORT int CVSpilsGetNumConvFails	(	void *	cvode_mem,
		long int *	nlcfails
	)

SUNDIALS_EXPORT int CVSpilsGetNumJtimesEvals	(	void *	cvode_mem,
		long int *	njvevals
	)

SUNDIALS_EXPORT int CVSpilsGetNumLinIters	(	void *	cvode_mem,
		long int *	nliters
	)

SUNDIALS_EXPORT int CVSpilsGetNumPrecEvals	(	void *	cvode_mem,
		long int *	npevals
	)

SUNDIALS_EXPORT int CVSpilsGetNumPrecSolves	(	void *	cvode_mem,
		long int *	npsolves
	)

SUNDIALS_EXPORT int CVSpilsGetNumRhsEvals	(	void *	cvode_mem,
		long int *	nfevalsLS
	)

SUNDIALS_EXPORT char* CVSpilsGetReturnFlagName

(

int

flag

)

SUNDIALS_EXPORT int CVSpilsGetWorkSpace	(	void *	cvode_mem,
		long int *	lenrwLS,
		long int *	leniwLS
	)

SUNDIALS_EXPORT int CVSpilsSetDelt	(	void *	cvode_mem,
		realtype	delt
	)

SUNDIALS_EXPORT int CVSpilsSetDeltB	(	void *	cvadj_mem,
		realtype	deltB
	)

SUNDIALS_EXPORT int CVSpilsSetGSType	(	void *	cvode_mem,
		int	gstype
	)

SUNDIALS_EXPORT int CVSpilsSetGSTypeB	(	void *	cvadj_mem,
		int	gstypeB
	)

SUNDIALS_EXPORT int CVSpilsSetJacTimesVecFn	(	void *	cvode_mem,
		CVSpilsJacTimesVecFn	jtimes,
		void *	jac_data
	)

SUNDIALS_EXPORT int CVSpilsSetJacTimesVecFnB	(	void *	cvadj_mem,
		CVSpilsJacTimesVecFnB	jtimesB,
		void *	jac_dataB
	)

SUNDIALS_EXPORT int CVSpilsSetMaxl	(	void *	cvode_mem,
		int	maxl
	)

SUNDIALS_EXPORT int CVSpilsSetMaxlB	(	void *	cvadj_mem,
		int	maxlB
	)

SUNDIALS_EXPORT int CVSpilsSetPreconditioner	(	void *	cvode_mem,
		CVSpilsPrecSetupFn	pset,
		CVSpilsPrecSolveFn	psolve,
		void *	P_data
	)

SUNDIALS_EXPORT int CVSpilsSetPreconditionerB	(	void *	cvadj_mem,
		CVSpilsPrecSetupFnB	psetB,
		CVSpilsPrecSolveFnB	psolveB,
		void *	P_dataB
	)

Referenced by main().

SUNDIALS_EXPORT int CVSpilsSetPrecType	(	void *	cvode_mem,
		int	pretype
	)

SUNDIALS_EXPORT int CVSpilsSetPrecTypeB	(	void *	cvadj_mem,
		int	pretypeB
	)