PreconditionSOR< MATRIX > Class Template Reference
[Preconditioners]

Inheritance diagram for PreconditionSOR< MATRIX >:

[legend]

List of all members.

Public Member Functions
template<class VECTOR >
void	vmult (VECTOR &, const VECTOR &) const
template<class VECTOR >
void	Tvmult (VECTOR &, const VECTOR &) const

---

Detailed Description

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

SOR preconditioner using matrix built-in function. The MATRIX class used is required to have functions precondition_SOR(VECTOR&, const VECTOR&, double) and precondition_TSOR(VECTOR&, const VECTOR&, double).

     // Declare related objects

 SparseMatrix<double> A;
 Vector<double> x;
 Vector<double> b;
 SolverCG<> solver(...);

 //...initialize and build A

     // Define and initialize preconditioner

 PreconditionSOR<SparseMatrix<double> > precondition;
 precondition.initialize (A, .6);

 solver.solve (A, x, b, precondition);

Author:

Guido Kanschat, 2000

---

Member Function Documentation

template<class MATRIX = SparseMatrix<double>>

template<class VECTOR >

void PreconditionSOR< MATRIX >::vmult	(	VECTOR &	,
		const VECTOR &
	)			const [inline]

Apply preconditioner.

template<class MATRIX = SparseMatrix<double>>

template<class VECTOR >

void PreconditionSOR< MATRIX >::Tvmult	(	VECTOR &	,
		const VECTOR &
	)			const [inline]

Apply transpose preconditioner.

---

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

• lac/include/lac/precondition.h