SAMRAI::solv::CVODEAbstractFunctions Class Reference

#include <source/solvers/packages/sundials/cvode/CVODEAbstractFunctions.h>

List of all members.

Public Member Functions
	CVODEAbstractFunctions ()
virtual	~CVODEAbstractFunctions ()
virtual int	evaluateRHSFunction (double t, SundialsAbstractVector *y, SundialsAbstractVector *y_dot)=0
virtual int	CVSpgmrPrecondSet (double t, SundialsAbstractVector *y, SundialsAbstractVector *fy, int jok, int *jcurPtr, double gamma, SundialsAbstractVector *vtemp1, SundialsAbstractVector *vtemp2, SundialsAbstractVector *vtemp3)=0
virtual int	CVSpgmrPrecondSolve (double t, SundialsAbstractVector *y, SundialsAbstractVector *fy, SundialsAbstractVector *r, SundialsAbstractVector *z, double gamma, double delta, int lr, SundialsAbstractVector *vtemp)=0

---

Detailed Description

Class CVODEAbstractFunctions is an abstract base class that defines an interface for the user-supplied RHSFunction and preconditioner routines to be used with CVODE and CVSpgmr via the C++ wrapper class CVODESolver. To use CVODE with the C++ wrapper one must derive a subclass of this base class and pass it into the CVODESolver constructor. The pure virtual member functions in this interface are used by CVODE and CVSpgmr during the ODE integration process. The complete argument lists in the function signatures defined by CVODE for the user-supplied routines have been preserved for the most part. In a few cases, some arguments do not appear in the function signatures below since they are superfluous via this interface.

See also:

solv::CVODESolver

solv::SundialsAbstractVector

---

Constructor & Destructor Documentation

SAMRAI::solv::CVODEAbstractFunctions::CVODEAbstractFunctions

(

)

The constructor and destructor for CVODEAbstractFunctions is empty.

SAMRAI::solv::CVODEAbstractFunctions::~CVODEAbstractFunctions

(

)

[virtual]

---

Member Function Documentation

virtual int SAMRAI::solv::CVODEAbstractFunctions::evaluateRHSFunction	(	double	t,
		SundialsAbstractVector *	y,
		SundialsAbstractVector *	y_dot
	)			[pure virtual]

User-supplied right-hand side function evaluation.

The function arguments are:

• t (INPUT) {current value of the independent variable}
• y (INPUT) {current value of dependent variable vector}
• y_dot (OUTPUT){current value of the derivative of y}

IMPORTANT: This function must not modify the vector y.

virtual int SAMRAI::solv::CVODEAbstractFunctions::CVSpgmrPrecondSet	(	double	t,
		SundialsAbstractVector *	y,
		SundialsAbstractVector *	fy,
		int	jok,
		int *	jcurPtr,
		double	gamma,
		SundialsAbstractVector *	vtemp1,
		SundialsAbstractVector *	vtemp2,
		SundialsAbstractVector *	vtemp3
	)			[pure virtual]

User-supplied function for setting up the preconditioner to be used in the solution of the linear system that arises during Newton iteration.

virtual int SAMRAI::solv::CVODEAbstractFunctions::CVSpgmrPrecondSolve	(	double	t,
		SundialsAbstractVector *	y,
		SundialsAbstractVector *	fy,
		SundialsAbstractVector *	r,
		SundialsAbstractVector *	z,
		double	gamma,
		double	delta,
		int	lr,
		SundialsAbstractVector *	vtemp
	)			[pure virtual]

User-supplied function for setting up the preconditioner to be used in the solution of the linear system that arises during Newton iteration.

---

The documentation for this class was generated from the following files:

• source/solvers/packages/sundials/cvode/CVODEAbstractFunctions.h
• source/solvers/packages/sundials/cvode/CVODEAbstractFunctions.C

---