ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR > Class Template Reference
[Derived matrices]

List of all members.

Public Member Functions
	ShiftedMatrixGeneralized (const MATRIX &A, const MASSMATRIX &M, const double sigma)
void	shift (const double sigma)
double	shift () const
void	vmult (VECTOR &dst, const VECTOR &src) const
double	residual (VECTOR &dst, const VECTOR &src, const VECTOR &rhs) const
Private Attributes
SmartPointer< const MATRIX >	A
SmartPointer< const MASSMATRIX >	M
VECTOR	aux
double	sigma

---

Detailed Description

template<class MATRIX, class MASSMATRIX, class VECTOR>
class ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >

Matrix with shifted diagonal values with respect to a certain scalar product.

Given a matrix A, this class implements a matrix-vector product with A+s M, where s is a provided shift parameter and M is the matrix representing the identity

Author:

Guido Kanschat, 2001

---

Constructor & Destructor Documentation

template<class MATRIX , class MASSMATRIX , class VECTOR >

ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::ShiftedMatrixGeneralized	(	const MATRIX &	A,
		const MASSMATRIX &	M,
		const double	sigma
	)			[inline]

Constructor. Provide the base matrix and a shift parameter.

---

Member Function Documentation

template<class MATRIX , class MASSMATRIX , class VECTOR >

void ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::shift

(

const double

sigma

)

[inline]

Set the shift parameter.

References ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::sigma.

template<class MATRIX , class MASSMATRIX , class VECTOR >

double ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::shift

(

)

const [inline]

Access to the shift parameter.

References ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::sigma.

template<class MATRIX , class MASSMATRIX , class VECTOR >

void ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::vmult	(	VECTOR &	dst,
		const VECTOR &	src
	)			const [inline]

Matrix-vector-product.

References ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::A, ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::aux, ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::M, and ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::sigma.

template<class MATRIX , class MASSMATRIX , class VECTOR >

double ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::residual	(	VECTOR &	dst,
		const VECTOR &	src,
		const VECTOR &	rhs
	)			const [inline]

Residual.

References ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::A, ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::aux, ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::M, and ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::sigma.

---

Member Data Documentation

template<class MATRIX , class MASSMATRIX , class VECTOR >

SmartPointer<const MATRIX> ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::A [private]

Storage for base matrix.

Referenced by ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::residual(), and ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::vmult().

template<class MATRIX , class MASSMATRIX , class VECTOR >

SmartPointer<const MASSMATRIX> ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::M [private]

Storage for mass matrix.

Referenced by ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::residual(), and ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::vmult().

template<class MATRIX , class MASSMATRIX , class VECTOR >

VECTOR ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::aux [private]

Auxiliary vector.

Referenced by ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::residual(), and ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::vmult().

template<class MATRIX , class MASSMATRIX , class VECTOR >

double ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::sigma [private]

Shift parameter.

Referenced by ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::residual(), ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::shift(), and ShiftedMatrixGeneralized< MATRIX, MASSMATRIX, VECTOR >::vmult().

---

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

• lac/include/lac/shifted_matrix.h