ElementGaussSeidel Preconditioner. More...

#include <element_gauss_seidel.h>

Inheritance diagram for ug::ElementGaussSeidel< TDomain, TAlgebra >:

Public Types
typedef TAlgebra	algebra_type
	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
	Matrix type.

typedef TAlgebra::vector_type	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
virtual SmartPtr< ILinearIterator< vector_type > >	clone ()
	Clone.

	ElementGaussSeidel ()
	default constructor

	ElementGaussSeidel (const std::string &type)
	constructor setting type

	ElementGaussSeidel (number relax)
	constructor setting relaxation

	ElementGaussSeidel (number relax, const std::string &type)
	constructor setting relaxation and type

void	select_schur_cmp (const std::vector< std::string > &cmp, number alpha)

void	set_elim_offdiag (bool elim)

void	set_relax (number omega)
	set relaxation parameter

void	set_type (const std::string &type)
	set type

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

virtual	~ElementGaussSeidel ()
	Destructor.

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 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 Types
typedef GridFunction< TDomain, TAlgebra >	grid_function_type

Protected Member Functions
virtual const char *	name () const
	Name of preconditioner.

virtual bool	postprocess ()
	Postprocess routine.

virtual bool	preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)
	Preprocess routine.

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

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_elim_off_diag

number	m_relax

number	m_schur_alpha

std::vector< std::string >	m_schur_cmp

std::string	m_type

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.

Detailed Description

template<typename TDomain, typename TAlgebra>
class ug::ElementGaussSeidel< TDomain, TAlgebra >

ElementGaussSeidel Preconditioner.

Member Typedef Documentation

◆ algebra_type

template<typename TDomain , typename TAlgebra >

typedef TAlgebra ug::ElementGaussSeidel< TDomain, TAlgebra >::algebra_type

Algebra type.

◆ base_type

template<typename TDomain , typename TAlgebra >

typedef IPreconditioner<TAlgebra> ug::ElementGaussSeidel< TDomain, TAlgebra >::base_type

Base type.

◆ grid_function_type

template<typename TDomain , typename TAlgebra >

typedef GridFunction<TDomain, TAlgebra> ug::ElementGaussSeidel< TDomain, TAlgebra >::grid_function_type

protected

◆ matrix_operator_type

template<typename TDomain , typename TAlgebra >

typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::ElementGaussSeidel< TDomain, TAlgebra >::matrix_operator_type

Matrix Operator type.

◆ matrix_type

template<typename TDomain , typename TAlgebra >

typedef TAlgebra::matrix_type ug::ElementGaussSeidel< TDomain, TAlgebra >::matrix_type

Matrix type.

◆ vector_type

template<typename TDomain , typename TAlgebra >

typedef TAlgebra::vector_type ug::ElementGaussSeidel< TDomain, TAlgebra >::vector_type

Vector type.

Constructor & Destructor Documentation

◆ ElementGaussSeidel() [1/4]

template<typename TDomain , typename TAlgebra >

ug::ElementGaussSeidel< TDomain, TAlgebra >::ElementGaussSeidel ( )

inline

default constructor

◆ ElementGaussSeidel() [2/4]

template<typename TDomain , typename TAlgebra >

ug::ElementGaussSeidel< TDomain, TAlgebra >::ElementGaussSeidel ( number relax )

inline

constructor setting relaxation

◆ ElementGaussSeidel() [3/4]

template<typename TDomain , typename TAlgebra >

ug::ElementGaussSeidel< TDomain, TAlgebra >::ElementGaussSeidel ( const std::string & type )

inline

constructor setting type

◆ ElementGaussSeidel() [4/4]

template<typename TDomain , typename TAlgebra >

ug::ElementGaussSeidel< TDomain, TAlgebra >::ElementGaussSeidel	(	number	relax,
		const std::string &	type
	)

inline

constructor setting relaxation and type

◆ ~ElementGaussSeidel()

template<typename TDomain , typename TAlgebra >

virtual ug::ElementGaussSeidel< TDomain, TAlgebra >::~ElementGaussSeidel ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ clone()

template<typename TDomain , typename TAlgebra >

virtual SmartPtr< ILinearIterator< vector_type > > ug::ElementGaussSeidel< TDomain, TAlgebra >::clone ( )

inlinevirtual

Clone.

Implements ug::ILinearIterator< TAlgebra::vector_type >.

References ug::ILinearIterator< TAlgebra::vector_type >::damping(), ug::DebugWritingObject< TAlgebra >::debug_writer(), ug::ElementGaussSeidel< TDomain, TAlgebra >::m_relax, ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_alpha, ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_cmp, and ug::ElementGaussSeidel< TDomain, TAlgebra >::m_type.

◆ name()

template<typename TDomain , typename TAlgebra >

virtual const char * ug::ElementGaussSeidel< TDomain, TAlgebra >::name ( ) const

inlineprotectedvirtual

Name of preconditioner.

Implements ug::IPreconditioner< TAlgebra >.

◆ postprocess()

template<typename TDomain , typename TAlgebra >

virtual bool ug::ElementGaussSeidel< TDomain, TAlgebra >::postprocess ( )

inlineprotectedvirtual

Postprocess routine.

Implements ug::IPreconditioner< TAlgebra >.

◆ preprocess()

template<typename TDomain , typename TAlgebra >

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

inlineprotectedvirtual

Preprocess routine.

Implements ug::IPreconditioner< TAlgebra >.

References ug::ElementGaussSeidel< TDomain, TAlgebra >::m_A, ug::MakeConsistent(), and pcl::NumProcs().

◆ select_schur_cmp()

template<typename TDomain , typename TAlgebra >

void ug::ElementGaussSeidel< TDomain, TAlgebra >::select_schur_cmp	(	const std::vector< std::string > &	cmp,
		number	alpha
	)

inline

References ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_alpha, and ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_cmp.

◆ set_elim_offdiag()

template<typename TDomain , typename TAlgebra >

void ug::ElementGaussSeidel< TDomain, TAlgebra >::set_elim_offdiag ( bool elim )

inline

References ug::ElementGaussSeidel< TDomain, TAlgebra >::m_elim_off_diag.

◆ set_relax()

template<typename TDomain , typename TAlgebra >

void ug::ElementGaussSeidel< TDomain, TAlgebra >::set_relax ( number omega )

inline

set relaxation parameter

References ug::ElementGaussSeidel< TDomain, TAlgebra >::m_relax.

◆ set_type()

template<typename TDomain , typename TAlgebra >

void ug::ElementGaussSeidel< TDomain, TAlgebra >::set_type ( const std::string & type )

inline

set type

References ug::ElementGaussSeidel< TDomain, TAlgebra >::m_type.

◆ step()

template<typename TDomain , typename TAlgebra >

virtual bool ug::ElementGaussSeidel< TDomain, TAlgebra >::step	(	SmartPtr< MatrixOperator< matrix_type, vector_type > >	pOp,
		vector_type &	c,
		const vector_type &	d
	)

inlineprotectedvirtual

computes a new correction c = B*d

This method computes a new correction c = B*d. It can only be called, when the preprocess has been done.

Parameters

[in]	mat	underlying matrix (i.e. L in L*u = f)
[out]	c	correction
[in]	d	defect

Returns: bool success flag

Implements ug::IPreconditioner< TAlgebra >.

References ug::ElementGaussSeidel< TDomain, TAlgebra >::m_A, ug::ElementGaussSeidel< TDomain, TAlgebra >::m_relax, ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_alpha, ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_cmp, ug::ElementGaussSeidel< TDomain, TAlgebra >::m_type, pcl::NumProcs(), ug::PST_CONSISTENT, ug::PST_UNIQUE, and UG_THROW.

◆ supports_parallel()

template<typename TDomain , typename TAlgebra >

virtual bool ug::ElementGaussSeidel< TDomain, TAlgebra >::supports_parallel ( ) const

inlinevirtual

returns if parallel solving is supported

Implements ug::ILinearIterator< TAlgebra::vector_type >.

Member Data Documentation

◆ m_A

template<typename TDomain , typename TAlgebra >

matrix_type ug::ElementGaussSeidel< TDomain, TAlgebra >::m_A

protected

Referenced by ug::ElementGaussSeidel< TDomain, TAlgebra >::preprocess(), and ug::ElementGaussSeidel< TDomain, TAlgebra >::step().

◆ m_elim_off_diag

template<typename TDomain , typename TAlgebra >

bool ug::ElementGaussSeidel< TDomain, TAlgebra >::m_elim_off_diag

protected

Referenced by ug::ElementGaussSeidel< TDomain, TAlgebra >::set_elim_offdiag().

◆ m_relax

template<typename TDomain , typename TAlgebra >

number ug::ElementGaussSeidel< TDomain, TAlgebra >::m_relax

protected

Referenced by ug::ElementGaussSeidel< TDomain, TAlgebra >::clone(), ug::ElementGaussSeidel< TDomain, TAlgebra >::set_relax(), and ug::ElementGaussSeidel< TDomain, TAlgebra >::step().

◆ m_schur_alpha

template<typename TDomain , typename TAlgebra >

number ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_alpha

protected

Referenced by ug::ElementGaussSeidel< TDomain, TAlgebra >::clone(), ug::ElementGaussSeidel< TDomain, TAlgebra >::select_schur_cmp(), and ug::ElementGaussSeidel< TDomain, TAlgebra >::step().

◆ m_schur_cmp

template<typename TDomain , typename TAlgebra >

std::vector<std::string> ug::ElementGaussSeidel< TDomain, TAlgebra >::m_schur_cmp

protected

Referenced by ug::ElementGaussSeidel< TDomain, TAlgebra >::clone(), ug::ElementGaussSeidel< TDomain, TAlgebra >::select_schur_cmp(), and ug::ElementGaussSeidel< TDomain, TAlgebra >::step().

◆ m_type

template<typename TDomain , typename TAlgebra >

std::string ug::ElementGaussSeidel< TDomain, TAlgebra >::m_type

protected

Referenced by ug::ElementGaussSeidel< TDomain, TAlgebra >::clone(), ug::ElementGaussSeidel< TDomain, TAlgebra >::set_type(), and ug::ElementGaussSeidel< TDomain, TAlgebra >::step().

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

ugbase/lib_disc/operator/linear_operator/element_gauss_seidel/element_gauss_seidel.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ algebra_type

◆ base_type

◆ grid_function_type

◆ matrix_operator_type

◆ matrix_type

◆ vector_type

Constructor & Destructor Documentation

◆ ElementGaussSeidel() [1/4]

◆ ElementGaussSeidel() [2/4]

◆ ElementGaussSeidel() [3/4]

◆ ElementGaussSeidel() [4/4]

◆ ~ElementGaussSeidel()

Member Function Documentation

◆ clone()

◆ name()

◆ postprocess()

◆ preprocess()

◆ select_schur_cmp()

◆ set_elim_offdiag()

◆ set_relax()

◆ set_type()

◆ step()

◆ supports_parallel()

Member Data Documentation

◆ m_A

◆ m_elim_off_diag

◆ m_relax

◆ m_schur_alpha

◆ m_schur_cmp

◆ m_type