RelaxationBlockSOR< MatrixType, inverse_type > Class Template Reference

#include <deal.II/lac/relaxation_block.h>

Inheritance diagram for RelaxationBlockSOR< MatrixType, inverse_type >:

Public Types
typedef MatrixType::value_type	number

Public Member Functions
template<typename number2 >
void	step (Vector< number2 > &dst, const Vector< number2 > &rhs) const
template<typename number2 >
void	Tstep (Vector< number2 > &dst, const Vector< number2 > &rhs) const
Public Member Functions inherited from Subscriptor
	Subscriptor ()
	Subscriptor (const Subscriptor &)
virtual	~Subscriptor ()
Subscriptor &	operator= (const Subscriptor &)
void	subscribe (const char *identifier=0) const
void	unsubscribe (const char *identifier=0) const
unsigned int	n_subscriptions () const
void	list_subscribers () const
	DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects."<< "\"<< "(Additional information: "<< arg3<< ")\"<< "See the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "a lot more information on what this error means and "<< "how to fix programs in which it happens.")
	DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier <"<< arg2<< "> subscribes to this object of class "<< arg1<< ". Consequently, it cannot be unsubscribed.")
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Additional Inherited Members
Protected Types inherited from RelaxationBlock< MatrixType, inverse_type >
typedef types::global_dof_index	size_type
Protected Types inherited from PreconditionBlockBase< inverse_type >
enum	Inversion
typedef types::global_dof_index	size_type
Protected Member Functions inherited from RelaxationBlock< MatrixType, inverse_type >
template<typename number2 >
void	do_step (Vector< number2 > &dst, const Vector< number2 > &prev, const Vector< number2 > &src, const bool backward) const
void	initialize (const MatrixType &A, const AdditionalData &parameters)
void	clear ()
bool	empty () const
value_type	el (size_type i, size_type j) const
void	invert_diagblocks ()
Protected Member Functions inherited from PreconditionBlockBase< inverse_type >
	PreconditionBlockBase (bool store_diagonals=false, Inversion method=gauss_jordan)
	~PreconditionBlockBase ()
void	clear ()
void	reinit (unsigned int nblocks, size_type blocksize, bool compress, Inversion method=gauss_jordan)
void	inverses_computed (bool are_they)
void	set_same_diagonal ()
bool	same_diagonal () const
bool	store_diagonals () const
bool	inverses_ready () const
bool	empty () const
unsigned int	size () const
inverse_type	el (size_type i, size_type j) const
void	inverse_vmult (size_type i, Vector< number2 > &dst, const Vector< number2 > &src) const
void	inverse_Tvmult (size_type i, Vector< number2 > &dst, const Vector< number2 > &src) const
FullMatrix< inverse_type > &	inverse (size_type i)
const FullMatrix< inverse_type > &	inverse (size_type i) const
Householder< inverse_type > &	inverse_householder (size_type i)
const Householder< inverse_type > &	inverse_householder (size_type i) const
LAPACKFullMatrix< inverse_type > &	inverse_svd (size_type i)
const LAPACKFullMatrix< inverse_type > &	inverse_svd (size_type i) const
FullMatrix< inverse_type > &	diagonal (size_type i)
const FullMatrix< inverse_type > &	diagonal (size_type i) const
void	log_statistics () const
std::size_t	memory_consumption () const
	DeclException0 (ExcDiagonalsNotStored)
	DeclException0 (ExcInverseNotAvailable)
Protected Attributes inherited from RelaxationBlock< MatrixType, inverse_type >
SmartPointer< const MatrixType, RelaxationBlock< MatrixType, inverse_type > >	A
SmartPointer< const AdditionalData, RelaxationBlock< MatrixType, inverse_type > >	additional_data
Protected Attributes inherited from PreconditionBlockBase< inverse_type >
Inversion	inversion

Detailed Description

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>
class RelaxationBlockSOR< MatrixType, inverse_type >

Block Gauss-Seidel method with possibly overlapping blocks.

This class implements the step() and Tstep() functions expected by the relaxation concept. They perform a multiplicative Schwarz method on the blocks provided in the block list of AdditionalData. Differing from PreconditionBlockSOR, these blocks may be of varying size, non-contiguous, and overlapping. On the other hand, this class does not implement the preconditioner interface expected by Solver objects.

Author

Guido Kanschat

Date

2010

Definition at line 335 of file relaxation_block.h.

Member Typedef Documentation

number

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>

typedef MatrixType::value_type RelaxationBlockSOR< MatrixType, inverse_type >::number

Default constructor. Define number type of matrix.

Definition at line 347 of file relaxation_block.h.

Member Function Documentation

step()

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

void RelaxationBlockSOR< MatrixType, inverse_type >::step	(	Vector< number2 > &	dst,
		const Vector< number2 > &	rhs
	)		const

Perform one step of the SOR iteration.

Tstep()

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>

template<typename number2 >

void RelaxationBlockSOR< MatrixType, inverse_type >::Tstep	(	Vector< number2 > &	dst,
		const Vector< number2 > &	rhs
	)		const

Perform one step of the transposed SOR iteration.

---

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

• deal.II/lac/relaxation_block.h