#include <gauss_seidel.h>

Inheritance diagram for ug::GaussSeidelBase< TAlgebra >:

Public Types
typedef TAlgebra	algebra_type

typedef IPreconditioner< TAlgebra >	base_type
	Base type.

typedef IPreconditioner< TAlgebra >::matrix_operator_type	matrix_operator_type
	Matrix Operator type.

typedef TAlgebra::matrix_type	matrix_type

typedef IOrderingAlgorithm< TAlgebra, ordering_container_type >	ordering_algo_type

typedef std::vector< size_t >	ordering_container_type
	Ordering type.

typedef TAlgebra::vector_type	vector_type

Public Types inherited from ug::IPreconditioner< TAlgebra >
typedef TAlgebra	algebra_type
	Algebra type.

typedef MatrixOperator< matrix_type, vector_type >	matrix_operator_type
	Matrix Operator type.

typedef TAlgebra::matrix_type	matrix_type
	Matrix type.

typedef TAlgebra::vector_type	vector_type
	Vector type.

Public Types inherited from ug::ILinearIterator< TAlgebra::vector_type >
typedef TAlgebra::vector_type	codomain_function_type
	Range space.

typedef TAlgebra::vector_type	domain_function_type
	Domain space.

Public Types inherited from ug::DebugWritingObject< TAlgebra >
typedef TAlgebra	algebra_type
	type of algebra

typedef TAlgebra::matrix_type	matrix_type
	type of matrix

typedef TAlgebra::vector_type	vector_type
	type of vector

Public Types inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
typedef TAlgebra::vector_type	vector_type
	type of vector

Public Member Functions
void	enable_consistent_interfaces (bool enable)
	activates the new parallelization approach (disabled by default)

void	enable_overlap (bool enable)

	GaussSeidelBase ()

	GaussSeidelBase (const GaussSeidelBase< TAlgebra > &parent)
	clone constructor

virtual const char *	name () const =0
	returns the name of iterator

void	set_ordering_algorithm (SmartPtr< ordering_algo_type > ordering_algo)
	sets an ordering algorithm

void	set_sor_relax (number relaxFactor)
	set relaxation parameter to define a SOR-method

Public Member Functions inherited from ug::IPreconditioner< TAlgebra >
virtual bool	apply (vector_type &c, const vector_type &d)
	compute new correction c = B*d

virtual bool	apply_update_defect (vector_type &c, vector_type &d)
	compute new correction c = Bd and update defect d:= d - Lc

SmartPtr< MatrixOperator< matrix_type, vector_type > >	approx_operator ()
	underlying matrix based operator used for the preconditioner

SmartPtr< MatrixOperator< matrix_type, vector_type > >	defect_operator ()
	underlying matrix based operator for calculation of defect

virtual bool	init (SmartPtr< ILinearOperator< vector_type > > J, const vector_type &u)
	implements the ILinearIterator-interface for matrix based preconditioner

bool	init (SmartPtr< ILinearOperator< vector_type > > L)
	implements the ILinearIterator-interface for matrix based preconditioner

bool	init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op)
	initializes the preconditioner for a matrix based operator

	IPreconditioner ()
	default constructor

	IPreconditioner (const IPreconditioner< TAlgebra > &parent)
	clone constructor

	IPreconditioner (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
	constructor setting debug writer

virtual void	set_approximation (SmartPtr< MatrixOperator< matrix_type, vector_type > > approx)

virtual	~IPreconditioner ()
	virtual destructor

Public Member Functions inherited from ug::ILinearIterator< TAlgebra::vector_type >
virtual SmartPtr< ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > >	clone ()=0
	clone

virtual std::string	config_string () const

SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > >	damping ()
	returns the scaling

	ILinearIterator ()
	constructor

	ILinearIterator (const ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > &parent)
	copy constructor

virtual bool	init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > J, const TAlgebra::vector_type &u)=0
	initialize for operator J(u) and linearization point u

virtual bool	init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > L)=0
	initialize for linear operator L

void	set_damp (number factor)
	sets the damping to a constant factor

void	set_damp (SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > spScaling)
	sets a scaling for the correction

virtual	~ILinearIterator ()
	virtual destructor

Public Member Functions inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > >	debug_writer ()
	returns the debug writer

ConstSmartPtr< IDebugWriter< algebra_type > >	debug_writer () const

bool	debug_writer_valid () const
	returns true if the debug writer is set

	DebugWritingObject ()

	DebugWritingObject (const DebugWritingObject< algebra_type > &parent)
	clone constructor

	DebugWritingObject (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)

virtual void	set_debug (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
	set debug writer

virtual	~DebugWritingObject ()
	virtual destructor

Public Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
virtual void	set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)
	set debug writer

SmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer ()
	returns the debug writer

ConstSmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer () const

bool	vector_debug_writer_valid () const
	returns true if the debug writer is set

	VectorDebugWritingObject ()

	VectorDebugWritingObject (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)

void	write_debug (const vector_type &vec, const char *filename)
	writing debug output for a vector (if debug writer set)

virtual	~VectorDebugWritingObject ()
	virtual destructor

Protected Member Functions
virtual bool	postprocess ()
	cleans the operator

virtual bool	preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)
	initializes the preconditioner

virtual void	step (const matrix_type &A, vector_type &c, const vector_type &d, const number relax)=0

virtual bool	step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d)
	computes a new correction c = B*d

virtual bool	supports_parallel () const
	returns if parallel solving is supported

Protected Member Functions inherited from ug::DebugWritingObject< TAlgebra >
void	enter_debug_writer_section (const char *secDir)
	enters a debugging section

void	enter_debug_writer_section (std::string secDir)
	enters a debugging section

void	leave_debug_writer_section ()
	leaves a debugging section

void	write_debug (const matrix_type &mat, const char *filename)
	write debug output for a matrix (if debug writer set)

void	write_debug (const matrix_type &mat, std::string name)
	write debug output for a matrix (if debug writer set)

Protected Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
void	enter_vector_debug_writer_section (const char *secDir)
	enters a debugging section

void	enter_vector_debug_writer_section (std::string secDir)
	enters a debugging section

void	leave_vector_debug_writer_section ()
	leaves a debugging section

void	print_debugger_message (const char *msg)
	prints a debugger message (listing all the sections)

void	print_debugger_message (std::string msg)
	prints a debugger message (listing all the sections)

virtual void	write_debug (const vector_type &vec, std::string name)
	writing debug output for a vector (if debug writer set)

Protected Attributes
matrix_type	m_A

bool	m_bConsistentInterfaces

vector_type	m_oC

vector_type	m_oD
	for overlaps only

number	m_relax
	relaxation parameter

SmartPtr< ordering_algo_type >	m_spOrderingAlgo
	for ordering algorithms

bool	m_useOverlap

Protected Attributes inherited from ug::IPreconditioner< TAlgebra >
bool	m_bInit
	init flag indicating if init has been called

bool	m_bOtherApproxOperator

SmartPtr< MatrixOperator< matrix_type, vector_type > >	m_spApproxOperator
	underlying matrix based operator used for the preconditioner

SmartPtr< ILinearOperator< vector_type > >	m_spDefectOperator
	underlying matrix based operator for calculation of defect

Protected Attributes inherited from ug::ILinearIterator< TAlgebra::vector_type >
SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > >	m_spDamping
	the scaling

Protected Attributes inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > >	m_spDebugWriter
	Debug Writer.

Protected Attributes inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
SmartPtr< IVectorDebugWriter< vector_type > >	m_spVectorDebugWriter
	Debug Writer.

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >

typedef TAlgebra ug::GaussSeidelBase< TAlgebra >::algebra_type

◆ base_type

template<typename TAlgebra >

typedef IPreconditioner<TAlgebra> ug::GaussSeidelBase< TAlgebra >::base_type

Base type.

◆ matrix_operator_type

template<typename TAlgebra >

typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::GaussSeidelBase< TAlgebra >::matrix_operator_type

Matrix Operator type.

◆ matrix_type

template<typename TAlgebra >

typedef TAlgebra::matrix_type ug::GaussSeidelBase< TAlgebra >::matrix_type

◆ ordering_algo_type

template<typename TAlgebra >

typedef IOrderingAlgorithm<TAlgebra, ordering_container_type> ug::GaussSeidelBase< TAlgebra >::ordering_algo_type

◆ ordering_container_type

template<typename TAlgebra >

typedef std::vector<size_t> ug::GaussSeidelBase< TAlgebra >::ordering_container_type

Ordering type.

◆ vector_type

template<typename TAlgebra >

typedef TAlgebra::vector_type ug::GaussSeidelBase< TAlgebra >::vector_type

Constructor & Destructor Documentation

◆ GaussSeidelBase() [1/2]

template<typename TAlgebra >

ug::GaussSeidelBase< TAlgebra >::GaussSeidelBase ( )

inline

◆ GaussSeidelBase() [2/2]

template<typename TAlgebra >

ug::GaussSeidelBase< TAlgebra >::GaussSeidelBase ( const GaussSeidelBase< TAlgebra > & parent )

inline

clone constructor

References ug::GaussSeidelBase< TAlgebra >::m_relax, and ug::GaussSeidelBase< TAlgebra >::set_sor_relax().

Member Function Documentation

◆ enable_consistent_interfaces()

template<typename TAlgebra >

void ug::GaussSeidelBase< TAlgebra >::enable_consistent_interfaces ( bool enable )

inline

activates the new parallelization approach (disabled by default)

References ug::GaussSeidelBase< TAlgebra >::m_bConsistentInterfaces.

◆ enable_overlap()

template<typename TAlgebra >

void ug::GaussSeidelBase< TAlgebra >::enable_overlap ( bool enable )

inline

References ug::GaussSeidelBase< TAlgebra >::m_useOverlap.

◆ name()

template<typename TAlgebra >

virtual const char * ug::GaussSeidelBase< TAlgebra >::name ( ) const

pure virtual

returns the name of iterator

This method returns the name of the iterator operator. This function is typically needed, when the iterator operator is used inside of another operator and some debug output should be printed

Returns: const char* name of inverse operator

Implements ug::IPreconditioner< TAlgebra >.

Implemented in ug::GaussSeidel< TAlgebra >, ug::BackwardGaussSeidel< TAlgebra >, ug::SymmetricGaussSeidel< TAlgebra >, ug::ProjGaussSeidel< TDomain, TAlgebra >, ug::ProjBackwardGaussSeidel< TDomain, TAlgebra >, ug::ProjSymmetricGaussSeidel< TDomain, TAlgebra >, and ug::IProjGaussSeidel< TDomain, TAlgebra >.

Referenced by ug::GaussSeidelBase< TAlgebra >::preprocess().

◆ postprocess()

template<typename TAlgebra >

virtual bool ug::GaussSeidelBase< TAlgebra >::postprocess ( )

inlineprotectedvirtual

cleans the operator

Implements ug::IPreconditioner< TAlgebra >.

◆ preprocess()

template<typename TAlgebra >

virtual bool ug::GaussSeidelBase< TAlgebra >::preprocess ( SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp )

inlineprotectedvirtual

initializes the preconditioner

This method is used to initialize the preconditioner. Usually, here are performed computationally expensive operations, that should only be computed once for an underlying matrix (e.g. LU factorization), while the preconditioner will by applied (using 'step'-method) several times.

Parameters

[in] mat underlying matrix (i.e. L in L*u = f)