PreconditionJacobi< MATRIX > Class Template Reference
[Preconditioners]

Inheritance diagram for PreconditionJacobi< 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 PreconditionJacobi< MATRIX >

Jacobi preconditioner using matrix built-in function. The MATRIX class used is required to have a function precondition_Jacobi(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

 PreconditionJacobi<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 PreconditionJacobi< MATRIX >::vmult	(	VECTOR &	,
		const VECTOR &
	)			const [inline]

Apply preconditioner.

template<class MATRIX = SparseMatrix<double>>

template<class VECTOR >

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

Apply transpose preconditioner. Since this is a symmetric preconditioner, this function is the same as vmult().

---

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

• lac/include/lac/precondition.h