SORaPrecond< T > Class Template Reference

The SOR_a preconditioner class template. More...

#include <SORa.hpp>

Inheritance diagram for SORaPrecond< T >:

[legend]Collaboration diagram for SORaPrecond< T >:

[legend]List of all members.

Public Member Functions
void	PrintParam ()
	Prints the name of the preconditioner.
void	PreProcess (void *&context, SparseMatrix< T > &A)
	Computes the lower triangular matrix of the precond.
void	Run (void *&context, MultiVector< T > &r, MultiVector< T > &c)
	Applies the preconditioner to a given vector 'r', i.e. computes .
virtual void	PostProcess (void *&context)
	Releases the information referenced by the context.
	SORaPrecond (unsigned the_disp_type, T the_alpha=1.5, T the_gamma=1)
	Constructor which sets the display type and the symmetry flag.

---

Detailed Description

template<typename T>
class SORaPrecond< T >

The SOR_a preconditioner class template.

---

Constructor & Destructor Documentation

template<typename T>

SORaPrecond< T >::SORaPrecond	(	unsigned	the_disp_type,
		T	the_alpha = 1.5,
		T	the_gamma = 1
	)			[inline]

Constructor which sets the display type and the symmetry flag.

Parameters:

[in]	the_disp_type	The parameters
[in]	the_alpha	The parameters
[in]	the_gamma	The parameters

---

Member Function Documentation

template<typename T>

void SORaPrecond< T >::PrintParam

(

)

[inline, virtual]

Prints the name of the preconditioner.

Implements SysPrecond< T >.

template<typename T>

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

Computes the lower triangular matrix of the precond.

Parameters:

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

Implements LinPrecond< T >.

template<typename T>

void SORaPrecond< 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 >.

template<typename T>

void SORaPrecond< T >::PostProcess

(

void *&

context

)

[inline, virtual]

Releases the information referenced by the context.

Parameters:

[in]

context

The context to release

Reimplemented from LinPrecond< T >.

---

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

• SORa.hpp
• SORa.cc

---