cvodes_bbdpre.h File Reference

#include <sundials/sundials_nvector.h>

Go to the source code of this file.

Defines
#define	CVBBDPRE_SUCCESS   0
#define	CVBBDPRE_PDATA_NULL   -11
#define	CVBBDPRE_FUNC_UNRECVR   -12
#define	CVBBDPRE_ADJMEM_NULL   -111
#define	CVBBDPRE_PDATAB_NULL   -112
#define	CVBBDPRE_MEM_FAIL   -113
Typedefs
typedef int(*	CVLocalFn )(int Nlocal, realtype t, N_Vector y, N_Vector g, void *f_data)
typedef int(*	CVCommFn )(int Nlocal, realtype t, N_Vector y, void *f_data)
typedef int(*	CVLocalFnB )(int NlocalB, realtype t, N_Vector y, N_Vector yB, N_Vector gB, void *f_dataB)
typedef int(*	CVCommFnB )(int NlocalB, realtype t, N_Vector y, N_Vector yB, void *f_dataB)
Functions
SUNDIALS_EXPORT void *	CVBBDPrecAlloc (void *cvode_mem, int Nlocal, int mudq, int mldq, int mukeep, int mlkeep, realtype dqrely, CVLocalFn gloc, CVCommFn cfn)
SUNDIALS_EXPORT int	CVBBDSptfqmr (void *cvode_mem, int pretype, int maxl, void *bbd_data)
SUNDIALS_EXPORT int	CVBBDSpbcg (void *cvode_mem, int pretype, int maxl, void *bbd_data)
SUNDIALS_EXPORT int	CVBBDSpgmr (void *cvode_mem, int pretype, int maxl, void *bbd_data)
SUNDIALS_EXPORT int	CVBBDPrecReInit (void *bbd_data, int mudq, int mldq, realtype dqrely, CVLocalFn gloc, CVCommFn cfn)
SUNDIALS_EXPORT void	CVBBDPrecFree (void **bbd_data)
SUNDIALS_EXPORT int	CVBBDPrecGetWorkSpace (void *bbd_data, long int *lenrwBBDP, long int *leniwBBDP)
SUNDIALS_EXPORT int	CVBBDPrecGetNumGfnEvals (void *bbd_data, long int *ngevalsBBDP)
SUNDIALS_EXPORT char *	CVBBDPrecGetReturnFlagName (int flag)
SUNDIALS_EXPORT int	CVBBDPrecAllocB (void *cvadj_mem, int NlocalB, int mudqB, int mldqB, int mukeepB, int mlkeepB, realtype dqrelyB, CVLocalFnB glocB, CVCommFnB cfnB)
SUNDIALS_EXPORT int	CVBBDSptfqmrB (void *cvadj_mem, int pretypeB, int maxlB)
SUNDIALS_EXPORT int	CVBBDSpbcgB (void *cvadj_mem, int pretypeB, int maxlB)
SUNDIALS_EXPORT int	CVBBDSpgmrB (void *cvadj_mem, int pretypeB, int maxlB)
SUNDIALS_EXPORT int	CVBBDPrecReInitB (void *cvadj_mem, int mudqB, int mldqB, realtype dqrelyB, CVLocalFnB glocB, CVCommFnB cfnB)
SUNDIALS_EXPORT void	CVBBDPrecFreeB (void *cvadj_mem)

---

Define Documentation

#define CVBBDPRE_ADJMEM_NULL   -111

#define CVBBDPRE_FUNC_UNRECVR   -12

#define CVBBDPRE_MEM_FAIL   -113

#define CVBBDPRE_PDATA_NULL   -11

#define CVBBDPRE_PDATAB_NULL   -112

#define CVBBDPRE_SUCCESS   0

---

Typedef Documentation

typedef int(* CVCommFn)(int Nlocal, realtype t, N_Vector y, void *f_data)

typedef int(* CVCommFnB)(int NlocalB, realtype t, N_Vector y, N_Vector yB, void *f_dataB)

typedef int(* CVLocalFn)(int Nlocal, realtype t, N_Vector y, N_Vector g, void *f_data)

typedef int(* CVLocalFnB)(int NlocalB, realtype t, N_Vector y, N_Vector yB, N_Vector gB, void *f_dataB)

---

Function Documentation

SUNDIALS_EXPORT void* CVBBDPrecAlloc	(	void *	cvode_mem,
		int	Nlocal,
		int	mudq,
		int	mldq,
		int	mukeep,
		int	mlkeep,
		realtype	dqrely,
		CVLocalFn	gloc,
		CVCommFn	cfn
	)

SUNDIALS_EXPORT int CVBBDPrecAllocB	(	void *	cvadj_mem,
		int	NlocalB,
		int	mudqB,
		int	mldqB,
		int	mukeepB,
		int	mlkeepB,
		realtype	dqrelyB,
		CVLocalFnB	glocB,
		CVCommFnB	cfnB
	)

SUNDIALS_EXPORT void CVBBDPrecFree

(

void **

bbd_data

)

SUNDIALS_EXPORT void CVBBDPrecFreeB

(

void *

cvadj_mem

)

SUNDIALS_EXPORT int CVBBDPrecGetNumGfnEvals	(	void *	bbd_data,
		long int *	ngevalsBBDP
	)

SUNDIALS_EXPORT char* CVBBDPrecGetReturnFlagName

(

int

flag

)

SUNDIALS_EXPORT int CVBBDPrecGetWorkSpace	(	void *	bbd_data,
		long int *	lenrwBBDP,
		long int *	leniwBBDP
	)

SUNDIALS_EXPORT int CVBBDPrecReInit	(	void *	bbd_data,
		int	mudq,
		int	mldq,
		realtype	dqrely,
		CVLocalFn	gloc,
		CVCommFn	cfn
	)

SUNDIALS_EXPORT int CVBBDPrecReInitB	(	void *	cvadj_mem,
		int	mudqB,
		int	mldqB,
		realtype	dqrelyB,
		CVLocalFnB	glocB,
		CVCommFnB	cfnB
	)

SUNDIALS_EXPORT int CVBBDSpbcg	(	void *	cvode_mem,
		int	pretype,
		int	maxl,
		void *	bbd_data
	)

SUNDIALS_EXPORT int CVBBDSpbcgB	(	void *	cvadj_mem,
		int	pretypeB,
		int	maxlB
	)

SUNDIALS_EXPORT int CVBBDSpgmr	(	void *	cvode_mem,
		int	pretype,
		int	maxl,
		void *	bbd_data
	)

SUNDIALS_EXPORT int CVBBDSpgmrB	(	void *	cvadj_mem,
		int	pretypeB,
		int	maxlB
	)

SUNDIALS_EXPORT int CVBBDSptfqmr	(	void *	cvode_mem,
		int	pretype,
		int	maxl,
		void *	bbd_data
	)

SUNDIALS_EXPORT int CVBBDSptfqmrB	(	void *	cvadj_mem,
		int	pretypeB,
		int	maxlB
	)