Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | List of all members
ShiftedMatrix< MATRIX > Class Template Reference

#include <shifted_matrix.h>

Public Member Functions

 ShiftedMatrix (const MATRIX &A, const double sigma)
 
void shift (const double sigma)
 
double shift () const
 
template<class VECTOR >
void vmult (VECTOR &dst, const VECTOR &src) const
 
template<class VECTOR >
double residual (VECTOR &dst, const VECTOR &src, const VECTOR &rhs) const
 

Private Attributes

SmartPointer< const MATRIX,
ShiftedMatrix< MATRIX > > 
A
 
double sigma
 

Detailed Description

template<class MATRIX>
class ShiftedMatrix< MATRIX >

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.

Author
Guido Kanschat, 2000, 2001

Definition at line 40 of file shifted_matrix.h.

Constructor & Destructor Documentation

template<class MATRIX >
ShiftedMatrix< MATRIX >::ShiftedMatrix ( const MATRIX A,
const double  sigma 
)
inline

Constructor. Provide the base matrix and a shift parameter.

Definition at line 157 of file shifted_matrix.h.

Member Function Documentation

template<class MATRIX >
void ShiftedMatrix< MATRIX >::shift ( const double  sigma)
inline

Set the shift parameter.

Definition at line 166 of file shifted_matrix.h.

template<class MATRIX >
double ShiftedMatrix< MATRIX >::shift ( ) const
inline

Access to the shift parameter.

Definition at line 174 of file shifted_matrix.h.

template<class MATRIX >
template<class VECTOR >
void ShiftedMatrix< MATRIX >::vmult ( VECTOR &  dst,
const VECTOR &  src 
) const
inline

Matrix-vector-product.

Definition at line 184 of file shifted_matrix.h.

template<class MATRIX >
template<class VECTOR >
double ShiftedMatrix< MATRIX >::residual ( VECTOR &  dst,
const VECTOR &  src,
const VECTOR &  rhs 
) const
inline

Residual.

Definition at line 195 of file shifted_matrix.h.

Member Data Documentation

template<class MATRIX>
SmartPointer<const MATRIX,ShiftedMatrix<MATRIX> > ShiftedMatrix< MATRIX >::A
private

Storage for base matrix.

Definition at line 75 of file shifted_matrix.h.

template<class MATRIX>
double ShiftedMatrix< MATRIX >::sigma
private

Auxiliary vector. Shift parameter.

Definition at line 84 of file shifted_matrix.h.


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