PreconditionRelaxation< MATRIX > Class Template Reference
[Preconditioners]

Inheritance diagram for PreconditionRelaxation< MATRIX >:

[legend]

List of all members.

Classes
class	AdditionalData
Public Member Functions
void	initialize (const MATRIX &A, AdditionalData parameters=AdditionalData())
void	clear ()
Protected Attributes
SmartPointer< const MATRIX >	A
double	relaxation

---

Detailed Description

template<class MATRIX = SparseMatrix<double>>
class PreconditionRelaxation< MATRIX >

Base class for other preconditioners. Here, only some common features Jacobi, SOR and SSOR preconditioners are implemented. For preconditioning, refer to derived classes.

Author:

Guido Kanschat, 2000

---

Member Function Documentation

template<class MATRIX = SparseMatrix<double>>

void PreconditionRelaxation< MATRIX >::initialize	(	const MATRIX &	A,
		AdditionalData	parameters = AdditionalData()
	)

Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object. The relaxation parameter should be larger than zero and smaller than 2 for numerical reasons. It defaults to 1.

Reimplemented in PreconditionSSOR< MATRIX >.

template<class MATRIX = SparseMatrix<double>>

void PreconditionRelaxation< MATRIX >::clear

(

)

Release the matrix and reset its pointer.

---

Member Data Documentation

template<class MATRIX = SparseMatrix<double>>

SmartPointer<const MATRIX> PreconditionRelaxation< MATRIX >::A [protected]

Pointer to the matrix object.

template<class MATRIX = SparseMatrix<double>>

double PreconditionRelaxation< MATRIX >::relaxation [protected]

Relaxation parameter.

---

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

• lac/include/lac/precondition.h