SAMRAI::solv::PVODEAbstractFunctions Class Reference

#include <source/solvers/packages/pvode_trio/pvode/wrapper/PVODEAbstractFunctions.h>

List of all members.

Public Member Functions
	PVODEAbstractFunctions ()
virtual	~PVODEAbstractFunctions ()
virtual void	evaluateRHSFunction (double t, PVodeTrioAbstractVector *y, PVodeTrioAbstractVector *y_dot)=0
virtual int	CVSpgmrPrecondSet (int neq, double t, PVodeTrioAbstractVector *y, PVodeTrioAbstractVector *fy, int jok, int *jcurPtr, double gamma, PVodeTrioAbstractVector *ewt, double h, double mach_roundoff, long int *nfePtr, void *P_data, PVodeTrioAbstractVector *vtemp1, PVodeTrioAbstractVector *vtemp2, PVodeTrioAbstractVector *vtemp3)=0
virtual int	CVSpgmrPrecondSolve (int neq, double t, PVodeTrioAbstractVector *y, PVodeTrioAbstractVector *fy, PVodeTrioAbstractVector *vtemp, double gamma, PVodeTrioAbstractVector *ewt, double delta, long int *nfePtr, PVodeTrioAbstractVector *r, int lr, void *P_data, PVodeTrioAbstractVector *z)=0

---

Detailed Description

Class PVODEAbstractFunctions is an abstract base class that defines an interface for the user-supplied RHSFunction and preconditioner routines to be used with PVODE and CVSpgmr via the C++ wrapper class PVODESolver. To use PVODE with the C++ wrapper one must derive a subclass of this base class and pass it into the PVODESolver constructor. The pure virtual member functions in this interface are used by PVODE and CVSpgmr during the ODE integration process. The complete argument lists in the function signatures defined by PVODE 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::PVODESolver

solv::PVodeTrioAbstractVector

---

Constructor & Destructor Documentation

SAMRAI::solv::PVODEAbstractFunctions::PVODEAbstractFunctions (   )

The constructor and destructor for PVODEAbstractFunctions is empty.

SAMRAI::solv::PVODEAbstractFunctions::~PVODEAbstractFunctions (   )  [virtual]

---

Member Function Documentation

virtual void SAMRAI::solv::PVODEAbstractFunctions::evaluateRHSFunction (  double  t, PVodeTrioAbstractVector *  y, PVodeTrioAbstractVector *  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::PVODEAbstractFunctions::CVSpgmrPrecondSet (  int  neq, double  t, PVodeTrioAbstractVector *  y, PVodeTrioAbstractVector *  fy, int  jok, int *  jcurPtr, double  gamma, PVodeTrioAbstractVector *  ewt, double  h, double  mach_roundoff, long int *  nfePtr, void *  P_data, PVodeTrioAbstractVector *  vtemp1, PVodeTrioAbstractVector *  vtemp2, PVodeTrioAbstractVector *  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::PVODEAbstractFunctions::CVSpgmrPrecondSolve (  int  neq, double  t, PVodeTrioAbstractVector *  y, PVodeTrioAbstractVector *  fy, PVodeTrioAbstractVector *  vtemp, double  gamma, PVodeTrioAbstractVector *  ewt, double  delta, long int *  nfePtr, PVodeTrioAbstractVector *  r, int  lr, void *  P_data, PVodeTrioAbstractVector *  z )  [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/pvode_trio/pvode/wrapper/PVODEAbstractFunctions.h
• source/solvers/packages/pvode_trio/pvode/wrapper/PVODEAbstractFunctions.C

---