GSPrecond< T > Class Template Reference

Template for the Gauss-Seidel preconditioners (simple and symmetric) for SparseMatrix<T> -matrices. More...

#include <GaussSeidel.hpp>

Inheritance diagram for GSPrecond< T >:

[legend]Collaboration diagram for GSPrecond< T >:

[legend]List of all members.

Public Member Functions
void	PrintParam ()
	Prints the name of the preconditioner.
void	PreProcess (void *&context, SparseMatrix< T > &A)
	Saves the system matrix.
void	Run (void *&context, MultiVector< T > &r, MultiVector< T > &c)
	Applies the preconditioner to a given vector 'r', i.e. computes .
	GSPrecond (unsigned the_disp_type, bool sym=0)
	Constructor which sets the display type and the symmetry flag.

---

Detailed Description

template<typename T>
class GSPrecond< T >

Template for the Gauss-Seidel preconditioners (simple and symmetric) for SparseMatrix<T> -matrices.

This version uses the lexicographical ordering of the grid points. The templates depend on a type T. This type should satisfy the conditions listed in small_matrix.hpp for small matrices.

Date:

Sep. 8, 2004 - created

---

Constructor & Destructor Documentation

template<typename T>

GSPrecond< T >::GSPrecond	(	unsigned	the_disp_type,
		bool	sym = 0
	)			[inline]

Constructor which sets the display type and the symmetry flag.

---

Member Function Documentation

template<typename T>

void GSPrecond< T >::PrintParam

(

)

[inline, virtual]

Prints the name of the preconditioner.

Implements SysPrecond< T >.

template<typename T>

void GSPrecond< T >::PreProcess	(	void *&	context,
		SparseMatrix< T > &	A
	)			[inline, virtual]

Saves the system matrix.

Parameters:

[in]	context	The preconditioner context to initialize
[in]	A	The system matrix hierarchy

Implements LinPrecond< T >.

template<typename T>

void GSPrecond< T >::Run	(	void *&	context,
		MultiVector< T > &	r,
		MultiVector< T > &	c
	)			[inline, virtual]

Applies the preconditioner to a given vector 'r', i.e. computes .

Parameters:

[in]	context	The preconditioner context
[in]	r	The residual
[in]	c	The correction

Implements LinPrecond< T >.

---

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

• GaussSeidel.hpp
• GaussSeidel.cc

---