sdODE Class Reference

Abstract base class for an ODE to be integrated by SundialsCvode. More...

#include <sundialsUtils.h>

Inheritance diagram for sdODE:

Public Member Functions
virtual int	f (const realtype t, const sdVector &y, sdVector &ydot)=0
	Evaluate the ODE function.
virtual int	g (realtype t, sdVector &y, realtype *gOut)
	Optional function for CVODE to find roots of.
virtual int	denseJacobian (const realtype t, const sdVector &y, const sdVector &ydot, sdMatrix &J)
	Optional function used to compute the dense Jacobian.
virtual int	bandedJacobian (const realtype t, const sdVector &y, const sdVector &ydot, sdBandMatrix &J)
	Optional function used to compute a banded Jacobian.
virtual	~sdODE ()

Detailed Description

Abstract base class for an ODE to be integrated by SundialsCvode.

Constructor & Destructor Documentation

~sdODE()

virtual sdODE::~sdODE ( )

inlinevirtual

Member Function Documentation

f()

virtual int sdODE::f ( const realtype t, const sdVector & y, sdVector & ydot )

pure virtual

Evaluate the ODE function.

\[ y' = f(y,t) \]

.

Parameters

	t	the current time
	y	the current vector of state variables
[out]	ydot	the computed time derivatives

Implemented in ConvectionSystemUTW, ConvectionSystemY, and SourceSystemCVODE.

g()

virtual int sdODE::g ( realtype t, sdVector & y, realtype * gOut )

inlinevirtual

Optional function for CVODE to find roots of.

Parameters

	t	the current time
	y	the current vector of state variables
[out]	gOut	the value of \[ g(y,t) \]

denseJacobian()

virtual int sdODE::denseJacobian ( const realtype t, const sdVector & y, const sdVector & ydot, sdMatrix & J )

inlinevirtual

Optional function used to compute the dense Jacobian.

Used in conjuction with CVDense.

Parameters

	t	the current time
	y	the current vector of state variables
	ydot	the current vector of time derivatives
[out]	J	The computed Jacobian matrix

Reimplemented in SourceSystemCVODE.

bandedJacobian()

virtual int sdODE::bandedJacobian ( const realtype t, const sdVector & y, const sdVector & ydot, sdBandMatrix & J )

inlinevirtual

Optional function used to compute a banded Jacobian.

Used in conjuction with CVBand.

Parameters

	t	the current time
	y	the current vector of state variables
	ydot	the current vector of time derivatives
[out]	J	The computed Jacobian matrix

---

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

• src/sundialsUtils.h