sdBandMatrix Class Reference

Wrapper class for Sundials SUNBandMatrix objects. More...

#include <sundialsUtils.h>

Public Member Functions
	sdBandMatrix (long int N, long int bwUpper, long int bwLower, SundialsContext &context)
	Create and wrap a new SUNBandMatrix.
	sdBandMatrix (SUNMatrix other)
	Create a wrapper for an existing SUNBandMatrix object.
	sdBandMatrix ()
	~sdBandMatrix ()
realtype &	operator() (long int i, long int j)
realtype &	operator() (long int i, long int j) const
SUNMatrix &	forSundials ()
	Return a pointer to the underlying SUNBandMatrix needed by Sundials functions.
void	print (const std::string &name="M") const

Private Attributes
SUNMatrix	M
bool	alloc

Detailed Description

Wrapper class for Sundials SUNBandMatrix objects.

Constructor & Destructor Documentation

sdBandMatrix() [1/3]

sdBandMatrix::sdBandMatrix	(	long int	N,
		long int	bwUpper,
		long int	bwLower,
		SundialsContext &	context
	)

Create and wrap a new SUNBandMatrix.

Parameters

N	dimension of the matrix (square)
bwUpper	upper bandwidth of the matrix
bwLower	lower bandwidth of the matrix

sdBandMatrix() [2/3]

sdBandMatrix::sdBandMatrix

(

SUNMatrix

other

)

Create a wrapper for an existing SUNBandMatrix object.

sdBandMatrix() [3/3]

sdBandMatrix::sdBandMatrix

(

)

~sdBandMatrix()

sdBandMatrix::~sdBandMatrix

(

)

Member Function Documentation

operator()() [1/2]

realtype & sdBandMatrix::operator() ( long int  i, long int  j  )

inline

operator()() [2/2]

realtype & sdBandMatrix::operator() ( long int  i, long int  j  ) const

inline

forSundials()

SUNMatrix & sdBandMatrix::forSundials ( )

inline

Return a pointer to the underlying SUNBandMatrix needed by Sundials functions.

print()

void sdBandMatrix::print

(

const std::string &

name = "M"

)

const

Member Data Documentation

M

SUNMatrix sdBandMatrix::M

private

alloc

bool sdBandMatrix::alloc

private

---

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

• src/sundialsUtils.h
• src/sundialsUtils.cpp