ShiftedMatrix< MatrixType > Class Template Reference

#include <deal.II/lac/shifted_matrix.h>

Public Member Functions
	ShiftedMatrix (const MatrixType &A, const double sigma)
void	shift (const double sigma)
double	shift () const
template<typename VectorType >
void	vmult (VectorType &dst, const VectorType &src) const
template<typename VectorType >
double	residual (VectorType &dst, const VectorType &src, const VectorType &rhs) const

Private Attributes
SmartPointer< const MatrixType, ShiftedMatrix< MatrixType > >	A
double	sigma

Detailed Description

template<typename MatrixType>
class ShiftedMatrix< MatrixType >

Matrix with shifted diagonal values.

Given a matrix A, this class implements a matrix-vector product with A+s I, where s is a provided shift parameter.

Deprecated:

If deal.II was configured with C++11 support, use the LinearOperator class instead, see the module on linear operators for further details.

Author

Guido Kanschat, 2000, 2001

Definition at line 43 of file shifted_matrix.h.

Constructor & Destructor Documentation

ShiftedMatrix()

template<typename MatrixType >

ShiftedMatrix< MatrixType >::ShiftedMatrix ( const MatrixType &  A, const double  sigma  )

inline

Constructor. Provide the base matrix and a shift parameter.

Definition at line 164 of file shifted_matrix.h.

Member Function Documentation

shift() [1/2]

template<typename MatrixType >

void ShiftedMatrix< MatrixType >::shift ( const double  sigma )

inline

Set the shift parameter.

Definition at line 174 of file shifted_matrix.h.

shift() [2/2]

template<typename MatrixType >

double ShiftedMatrix< MatrixType >::shift ( ) const

inline

Access to the shift parameter.

Definition at line 182 of file shifted_matrix.h.

vmult()

template<typename MatrixType >

template<class VectorType >

void ShiftedMatrix< MatrixType >::vmult ( VectorType &  dst, const VectorType &  src  ) const

inline

Matrix-vector-product.

Definition at line 192 of file shifted_matrix.h.

residual()

template<typename MatrixType >

template<class VectorType >

double ShiftedMatrix< MatrixType >::residual ( VectorType &  dst, const VectorType &  src, const VectorType &  rhs  ) const

inline

Residual.

Definition at line 203 of file shifted_matrix.h.

Member Data Documentation

A

template<typename MatrixType>

SmartPointer<const MatrixType,ShiftedMatrix<MatrixType> > ShiftedMatrix< MatrixType >::A

private

Storage for base matrix.

Definition at line 77 of file shifted_matrix.h.

sigma

template<typename MatrixType>

double ShiftedMatrix< MatrixType >::sigma

private

Auxiliary vector. Shift parameter.

Definition at line 86 of file shifted_matrix.h.

---

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

• deal.II/lac/shifted_matrix.h