cvode.h File Reference

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

Go to the source code of this file.

Defines
#define	CV_ADAMS   1
#define	CV_BDF   2
#define	CV_FUNCTIONAL   1
#define	CV_NEWTON   2
#define	CV_SS   1
#define	CV_SV   2
#define	CV_WF   3
#define	CV_NORMAL   1
#define	CV_ONE_STEP   2
#define	CV_NORMAL_TSTOP   3
#define	CV_ONE_STEP_TSTOP   4
#define	CV_SUCCESS   0
#define	CV_TSTOP_RETURN   1
#define	CV_ROOT_RETURN   2
#define	CV_WARNING   99
#define	CV_TOO_MUCH_WORK   -1
#define	CV_TOO_MUCH_ACC   -2
#define	CV_ERR_FAILURE   -3
#define	CV_CONV_FAILURE   -4
#define	CV_LINIT_FAIL   -5
#define	CV_LSETUP_FAIL   -6
#define	CV_LSOLVE_FAIL   -7
#define	CV_RHSFUNC_FAIL   -8
#define	CV_FIRST_RHSFUNC_ERR   -9
#define	CV_REPTD_RHSFUNC_ERR   -10
#define	CV_UNREC_RHSFUNC_ERR   -11
#define	CV_RTFUNC_FAIL   -12
#define	CV_MEM_FAIL   -20
#define	CV_MEM_NULL   -21
#define	CV_ILL_INPUT   -22
#define	CV_NO_MALLOC   -23
#define	CV_BAD_K   -24
#define	CV_BAD_T   -25
#define	CV_BAD_DKY   -26
#define	CV_TOO_CLOSE   -27
Typedefs
typedef int(*	CVRhsFn )(realtype t, N_Vector y, N_Vector ydot, void *f_data)
typedef int(*	CVRootFn )(realtype t, N_Vector y, realtype *gout, void *g_data)
typedef int(*	CVEwtFn )(N_Vector y, N_Vector ewt, void *e_data)
typedef void(*	CVErrHandlerFn )(int error_code, const char *module, const char *function, char *msg, void *eh_data)
Functions
SUNDIALS_EXPORT void *	CVodeCreate (int lmm, int iter)
SUNDIALS_EXPORT int	CVodeSetErrHandlerFn (void *cvode_mem, CVErrHandlerFn ehfun, void *eh_data)
SUNDIALS_EXPORT int	CVodeSetErrFile (void *cvode_mem, FILE *errfp)
SUNDIALS_EXPORT int	CVodeSetFdata (void *cvode_mem, void *f_data)
SUNDIALS_EXPORT int	CVodeSetEwtFn (void *cvode_mem, CVEwtFn efun, void *e_data)
SUNDIALS_EXPORT int	CVodeSetMaxOrd (void *cvode_mem, int maxord)
SUNDIALS_EXPORT int	CVodeSetMaxNumSteps (void *cvode_mem, long int mxsteps)
SUNDIALS_EXPORT int	CVodeSetMaxHnilWarns (void *cvode_mem, int mxhnil)
SUNDIALS_EXPORT int	CVodeSetStabLimDet (void *cvode_mem, booleantype stldet)
SUNDIALS_EXPORT int	CVodeSetInitStep (void *cvode_mem, realtype hin)
SUNDIALS_EXPORT int	CVodeSetMinStep (void *cvode_mem, realtype hmin)
SUNDIALS_EXPORT int	CVodeSetMaxStep (void *cvode_mem, realtype hmax)
SUNDIALS_EXPORT int	CVodeSetStopTime (void *cvode_mem, realtype tstop)
SUNDIALS_EXPORT int	CVodeSetMaxErrTestFails (void *cvode_mem, int maxnef)
SUNDIALS_EXPORT int	CVodeSetMaxNonlinIters (void *cvode_mem, int maxcor)
SUNDIALS_EXPORT int	CVodeSetMaxConvFails (void *cvode_mem, int maxncf)
SUNDIALS_EXPORT int	CVodeSetNonlinConvCoef (void *cvode_mem, realtype nlscoef)
SUNDIALS_EXPORT int	CVodeSetIterType (void *cvode_mem, int iter)
SUNDIALS_EXPORT int	CVodeSetTolerances (void *cvode_mem, int itol, realtype reltol, void *abstol)
SUNDIALS_EXPORT int	CVodeMalloc (void *cvode_mem, CVRhsFn f, realtype t0, N_Vector y0, int itol, realtype reltol, void *abstol)
SUNDIALS_EXPORT int	CVodeReInit (void *cvode_mem, CVRhsFn f, realtype t0, N_Vector y0, int itol, realtype reltol, void *abstol)
SUNDIALS_EXPORT int	CVodeRootInit (void *cvode_mem, int nrtfn, CVRootFn g, void *g_data)
SUNDIALS_EXPORT int	CVode (void *cvode_mem, realtype tout, N_Vector yout, realtype *tret, int itask)
SUNDIALS_EXPORT int	CVodeGetDky (void *cvode_mem, realtype t, int k, N_Vector dky)
SUNDIALS_EXPORT int	CVodeGetWorkSpace (void *cvode_mem, long int *lenrw, long int *leniw)
SUNDIALS_EXPORT int	CVodeGetNumSteps (void *cvode_mem, long int *nsteps)
SUNDIALS_EXPORT int	CVodeGetNumRhsEvals (void *cvode_mem, long int *nfevals)
SUNDIALS_EXPORT int	CVodeGetNumLinSolvSetups (void *cvode_mem, long int *nlinsetups)
SUNDIALS_EXPORT int	CVodeGetNumErrTestFails (void *cvode_mem, long int *netfails)
SUNDIALS_EXPORT int	CVodeGetLastOrder (void *cvode_mem, int *qlast)
SUNDIALS_EXPORT int	CVodeGetCurrentOrder (void *cvode_mem, int *qcur)
SUNDIALS_EXPORT int	CVodeGetNumStabLimOrderReds (void *cvode_mem, long int *nslred)
SUNDIALS_EXPORT int	CVodeGetActualInitStep (void *cvode_mem, realtype *hinused)
SUNDIALS_EXPORT int	CVodeGetLastStep (void *cvode_mem, realtype *hlast)
SUNDIALS_EXPORT int	CVodeGetCurrentStep (void *cvode_mem, realtype *hcur)
SUNDIALS_EXPORT int	CVodeGetCurrentTime (void *cvode_mem, realtype *tcur)
SUNDIALS_EXPORT int	CVodeGetTolScaleFactor (void *cvode_mem, realtype *tolsfac)
SUNDIALS_EXPORT int	CVodeGetErrWeights (void *cvode_mem, N_Vector eweight)
SUNDIALS_EXPORT int	CVodeGetEstLocalErrors (void *cvode_mem, N_Vector ele)
SUNDIALS_EXPORT int	CVodeGetNumGEvals (void *cvode_mem, long int *ngevals)
SUNDIALS_EXPORT int	CVodeGetRootInfo (void *cvode_mem, int *rootsfound)
SUNDIALS_EXPORT int	CVodeGetIntegratorStats (void *cvode_mem, long int *nsteps, long int *nfevals, long int *nlinsetups, long int *netfails, int *qlast, int *qcur, realtype *hinused, realtype *hlast, realtype *hcur, realtype *tcur)
SUNDIALS_EXPORT int	CVodeGetNumNonlinSolvIters (void *cvode_mem, long int *nniters)
SUNDIALS_EXPORT int	CVodeGetNumNonlinSolvConvFails (void *cvode_mem, long int *nncfails)
SUNDIALS_EXPORT int	CVodeGetNonlinSolvStats (void *cvode_mem, long int *nniters, long int *nncfails)
SUNDIALS_EXPORT char *	CVodeGetReturnFlagName (int flag)
SUNDIALS_EXPORT void	CVodeFree (void **cvode_mem)

---

Define Documentation

#define CV_ADAMS   1

Referenced by main().

#define CV_BAD_DKY   -26

#define CV_BAD_K   -24

#define CV_BAD_T   -25

#define CV_BDF   2

Referenced by main().

#define CV_CONV_FAILURE   -4

#define CV_ERR_FAILURE   -3

#define CV_FIRST_RHSFUNC_ERR   -9

#define CV_FUNCTIONAL   1

Referenced by main().

#define CV_ILL_INPUT   -22

#define CV_LINIT_FAIL   -5

#define CV_LSETUP_FAIL   -6

#define CV_LSOLVE_FAIL   -7

#define CV_MEM_FAIL   -20

#define CV_MEM_NULL   -21

#define CV_NEWTON   2

Referenced by main().

#define CV_NO_MALLOC   -23

#define CV_NORMAL   1

Referenced by main().

#define CV_NORMAL_TSTOP   3

#define CV_ONE_STEP   2

#define CV_ONE_STEP_TSTOP   4

#define CV_REPTD_RHSFUNC_ERR   -10

#define CV_RHSFUNC_FAIL   -8

#define CV_ROOT_RETURN   2

Referenced by main().

#define CV_RTFUNC_FAIL   -12

#define CV_SS   1

Referenced by main().

#define CV_SUCCESS   0

Referenced by main().

#define CV_SV   2

Referenced by main().

#define CV_TOO_CLOSE   -27

#define CV_TOO_MUCH_ACC   -2

#define CV_TOO_MUCH_WORK   -1

#define CV_TSTOP_RETURN   1

#define CV_UNREC_RHSFUNC_ERR   -11

#define CV_WARNING   99

#define CV_WF   3

Referenced by main().

---

Typedef Documentation

typedef void(* CVErrHandlerFn)(int error_code, const char *module, const char *function, char *msg, void *eh_data)

typedef int(* CVEwtFn)(N_Vector y, N_Vector ewt, void *e_data)

typedef int(* CVRhsFn)(realtype t, N_Vector y, N_Vector ydot, void *f_data)

typedef int(* CVRootFn)(realtype t, N_Vector y, realtype *gout, void *g_data)

---

Function Documentation

SUNDIALS_EXPORT int CVode	(	void *	cvode_mem,
		realtype	tout,
		N_Vector	yout,
		realtype *	tret,
		int	itask
	)

Referenced by main().

SUNDIALS_EXPORT void* CVodeCreate	(	int	lmm,
		int	iter
	)

Referenced by main().

SUNDIALS_EXPORT void CVodeFree

(

void **

cvode_mem

)

Referenced by main().

SUNDIALS_EXPORT int CVodeGetActualInitStep	(	void *	cvode_mem,
		realtype *	hinused
	)

SUNDIALS_EXPORT int CVodeGetCurrentOrder	(	void *	cvode_mem,
		int *	qcur
	)

SUNDIALS_EXPORT int CVodeGetCurrentStep	(	void *	cvode_mem,
		realtype *	hcur
	)

SUNDIALS_EXPORT int CVodeGetCurrentTime	(	void *	cvode_mem,
		realtype *	tcur
	)

SUNDIALS_EXPORT int CVodeGetDky	(	void *	cvode_mem,
		realtype	t,
		int	k,
		N_Vector	dky
	)

SUNDIALS_EXPORT int CVodeGetErrWeights	(	void *	cvode_mem,
		N_Vector	eweight
	)

SUNDIALS_EXPORT int CVodeGetEstLocalErrors	(	void *	cvode_mem,
		N_Vector	ele
	)

SUNDIALS_EXPORT int CVodeGetIntegratorStats	(	void *	cvode_mem,
		long int *	nsteps,
		long int *	nfevals,
		long int *	nlinsetups,
		long int *	netfails,
		int *	qlast,
		int *	qcur,
		realtype *	hinused,
		realtype *	hlast,
		realtype *	hcur,
		realtype *	tcur
	)

SUNDIALS_EXPORT int CVodeGetLastOrder	(	void *	cvode_mem,
		int *	qlast
	)

SUNDIALS_EXPORT int CVodeGetLastStep	(	void *	cvode_mem,
		realtype *	hlast
	)

SUNDIALS_EXPORT int CVodeGetNonlinSolvStats	(	void *	cvode_mem,
		long int *	nniters,
		long int *	nncfails
	)

SUNDIALS_EXPORT int CVodeGetNumErrTestFails	(	void *	cvode_mem,
		long int *	netfails
	)

SUNDIALS_EXPORT int CVodeGetNumGEvals	(	void *	cvode_mem,
		long int *	ngevals
	)

SUNDIALS_EXPORT int CVodeGetNumLinSolvSetups	(	void *	cvode_mem,
		long int *	nlinsetups
	)

SUNDIALS_EXPORT int CVodeGetNumNonlinSolvConvFails	(	void *	cvode_mem,
		long int *	nncfails
	)

SUNDIALS_EXPORT int CVodeGetNumNonlinSolvIters	(	void *	cvode_mem,
		long int *	nniters
	)

SUNDIALS_EXPORT int CVodeGetNumRhsEvals	(	void *	cvode_mem,
		long int *	nfevals
	)

SUNDIALS_EXPORT int CVodeGetNumStabLimOrderReds	(	void *	cvode_mem,
		long int *	nslred
	)

SUNDIALS_EXPORT int CVodeGetNumSteps	(	void *	cvode_mem,
		long int *	nsteps
	)

Referenced by main().

SUNDIALS_EXPORT char* CVodeGetReturnFlagName

(

int

flag

)

SUNDIALS_EXPORT int CVodeGetRootInfo	(	void *	cvode_mem,
		int *	rootsfound
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeGetTolScaleFactor	(	void *	cvode_mem,
		realtype *	tolsfac
	)

SUNDIALS_EXPORT int CVodeGetWorkSpace	(	void *	cvode_mem,
		long int *	lenrw,
		long int *	leniw
	)

SUNDIALS_EXPORT int CVodeMalloc	(	void *	cvode_mem,
		CVRhsFn	f,
		realtype	t0,
		N_Vector	y0,
		int	itol,
		realtype	reltol,
		void *	abstol
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeReInit	(	void *	cvode_mem,
		CVRhsFn	f,
		realtype	t0,
		N_Vector	y0,
		int	itol,
		realtype	reltol,
		void *	abstol
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeRootInit	(	void *	cvode_mem,
		int	nrtfn,
		CVRootFn	g,
		void *	g_data
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeSetErrFile	(	void *	cvode_mem,
		FILE *	errfp
	)

SUNDIALS_EXPORT int CVodeSetErrHandlerFn	(	void *	cvode_mem,
		CVErrHandlerFn	ehfun,
		void *	eh_data
	)

SUNDIALS_EXPORT int CVodeSetEwtFn	(	void *	cvode_mem,
		CVEwtFn	efun,
		void *	e_data
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeSetFdata	(	void *	cvode_mem,
		void *	f_data
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeSetInitStep	(	void *	cvode_mem,
		realtype	hin
	)

SUNDIALS_EXPORT int CVodeSetIterType	(	void *	cvode_mem,
		int	iter
	)

SUNDIALS_EXPORT int CVodeSetMaxConvFails	(	void *	cvode_mem,
		int	maxncf
	)

SUNDIALS_EXPORT int CVodeSetMaxErrTestFails	(	void *	cvode_mem,
		int	maxnef
	)

SUNDIALS_EXPORT int CVodeSetMaxHnilWarns	(	void *	cvode_mem,
		int	mxhnil
	)

SUNDIALS_EXPORT int CVodeSetMaxNonlinIters	(	void *	cvode_mem,
		int	maxcor
	)

SUNDIALS_EXPORT int CVodeSetMaxNumSteps	(	void *	cvode_mem,
		long int	mxsteps
	)

Referenced by main().

SUNDIALS_EXPORT int CVodeSetMaxOrd	(	void *	cvode_mem,
		int	maxord
	)

SUNDIALS_EXPORT int CVodeSetMaxStep	(	void *	cvode_mem,
		realtype	hmax
	)

SUNDIALS_EXPORT int CVodeSetMinStep	(	void *	cvode_mem,
		realtype	hmin
	)

SUNDIALS_EXPORT int CVodeSetNonlinConvCoef	(	void *	cvode_mem,
		realtype	nlscoef
	)

SUNDIALS_EXPORT int CVodeSetStabLimDet	(	void *	cvode_mem,
		booleantype	stldet
	)

SUNDIALS_EXPORT int CVodeSetStopTime	(	void *	cvode_mem,
		realtype	tstop
	)

SUNDIALS_EXPORT int CVodeSetTolerances	(	void *	cvode_mem,
		int	itol,
		realtype	reltol,
		void *	abstol
	)