#include <agglomerating_solver.h>

Inheritance diagram for ug::AgglomeratingPreconditioner< TAlgebra >:

Public Types
typedef TAlgebra	algebra_type

typedef AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >	base_type
	Base type.

typedef TAlgebra::matrix_type	matrix_type

typedef TAlgebra::vector_type	vector_type

Public Types inherited from ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >
typedef TAlgebra	algebra_type

typedef TAlgebra::matrix_type	matrix_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
	AgglomeratingPreconditioner (SmartPtr< ILinearIterator< vector_type > > splinIt)

virtual bool	apply_agglomerated (vector_type &x, const vector_type &b)

virtual SmartPtr< ILinearIterator< vector_type > >	clone ()
	Clone.

virtual std::string	config_string () const

virtual bool	init_agglomerated (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op)

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

virtual bool	postprocess ()
	cleans the operator

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

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

virtual	~AgglomeratingPreconditioner ()

Public Member Functions inherited from ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >
virtual bool	apply (vector_type &x, const vector_type &b)

virtual bool	apply_return_defect (vector_type &u, vector_type &f)

virtual bool	apply_update_defect (vector_type &u, vector_type &f)

virtual bool	base_init (SmartPtr< ILinearOperator< vector_type > > A)

bool	base_init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op)
	Preprocess routine.

void	broadcast_vector_from_one (vector_type &x, const vector_type &collectedX, ParallelStorageType type)

bool	empty ()

void	gather_vector_on_one (vector_type &collectedB, const vector_type &b, ParallelStorageType type)

bool	i_am_root ()

virtual bool	init_agglomerated (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op)=0

void	init_collected_vec (vector_type &collectedX)

bool	init_mat (const matrix_type &A)

bool	is_serial ()

virtual bool	step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d)

virtual	~AgglomeratingBase ()

Public Member Functions inherited from ug::IPreconditioner< TAlgebra >
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 >
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 Attributes
std::string	m_name

SmartPtr< ILinearIterator< vector_type > >	m_splinIt

Protected Attributes inherited from ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >
HorizontalAlgebraLayouts	agglomerationLayout

vector_type	collectedB

vector_type	collectedX

bool	m_bEmpty

bool	m_bRoot

matrix_type *	m_pMatrix

SmartPtr< MatrixOperator< matrix_type, vector_type > >	m_spCollectedOp

SmartPtr< AlgebraLayouts >	m_spLocalAlgebraLayouts

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.

Additional Inherited Members
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)

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >

typedef TAlgebra ug::AgglomeratingPreconditioner< TAlgebra >::algebra_type

◆ base_type

template<typename TAlgebra >

typedef AgglomeratingBase<IPreconditioner<TAlgebra>, TAlgebra > ug::AgglomeratingPreconditioner< TAlgebra >::base_type

Base type.

◆ matrix_type

template<typename TAlgebra >

typedef TAlgebra::matrix_type ug::AgglomeratingPreconditioner< TAlgebra >::matrix_type

◆ vector_type

template<typename TAlgebra >

typedef TAlgebra::vector_type ug::AgglomeratingPreconditioner< TAlgebra >::vector_type

Constructor & Destructor Documentation

◆ AgglomeratingPreconditioner()

template<typename TAlgebra >

ug::AgglomeratingPreconditioner< TAlgebra >::AgglomeratingPreconditioner ( SmartPtr< ILinearIterator< vector_type > > splinIt )

inline

References ug::AgglomeratingPreconditioner< TAlgebra >::m_name, ug::AgglomeratingPreconditioner< TAlgebra >::m_splinIt, and UG_COND_THROW.

◆ ~AgglomeratingPreconditioner()

template<typename TAlgebra >

virtual ug::AgglomeratingPreconditioner< TAlgebra >::~AgglomeratingPreconditioner ( )

inlinevirtual

Member Function Documentation

◆ apply_agglomerated()

template<typename TAlgebra >

virtual bool ug::AgglomeratingPreconditioner< TAlgebra >::apply_agglomerated	(	vector_type &	x,
		const vector_type &	b
	)

inlinevirtual

Implements ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >.

References ug::AgglomeratingPreconditioner< TAlgebra >::m_splinIt, and UG_CATCH_THROW.

◆ clone()

template<typename TAlgebra >

virtual SmartPtr< ILinearIterator< vector_type > > ug::AgglomeratingPreconditioner< TAlgebra >::clone ( )

inlinevirtual

Clone.

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

References ug::AgglomeratingPreconditioner< TAlgebra >::m_splinIt, and make_sp().

◆ config_string()

template<typename TAlgebra >

virtual std::string ug::AgglomeratingPreconditioner< TAlgebra >::config_string ( ) const

inlinevirtual

Reimplemented from ug::ILinearIterator< TAlgebra::vector_type >.

References ug::AgglomeratingPreconditioner< TAlgebra >::m_splinIt.

◆ init_agglomerated()

template<typename TAlgebra >

virtual bool ug::AgglomeratingPreconditioner< TAlgebra >::init_agglomerated ( SmartPtr< MatrixOperator< matrix_type, vector_type > > Op )

inlinevirtual

References ug::AgglomeratingPreconditioner< TAlgebra >::m_splinIt, and UG_CATCH_THROW.

◆ name()

template<typename TAlgebra >

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

inlinevirtual

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

References ug::AgglomeratingPreconditioner< TAlgebra >::m_name.

◆ postprocess()

template<typename TAlgebra >

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

inlinevirtual

cleans the operator

Implements ug::IPreconditioner< TAlgebra >.

◆ preprocess()

template<typename TAlgebra >

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

inlinevirtual

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)

Returns: bool success flag

Implements ug::IPreconditioner< TAlgebra >.

References ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >::base_init().

◆ supports_parallel()

template<typename TAlgebra >

virtual bool ug::AgglomeratingPreconditioner< TAlgebra >::supports_parallel ( ) const

inlinevirtual

returns if parallel solving is supported

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

Member Data Documentation

◆ m_name

template<typename TAlgebra >

std::string ug::AgglomeratingPreconditioner< TAlgebra >::m_name

protected

Referenced by ug::AgglomeratingPreconditioner< TAlgebra >::AgglomeratingPreconditioner(), and ug::AgglomeratingPreconditioner< TAlgebra >::name().

◆ m_splinIt

template<typename TAlgebra >

SmartPtr<ILinearIterator<vector_type> > ug::AgglomeratingPreconditioner< TAlgebra >::m_splinIt

protected

Referenced by ug::AgglomeratingPreconditioner< TAlgebra >::AgglomeratingPreconditioner(), ug::AgglomeratingPreconditioner< TAlgebra >::apply_agglomerated(), ug::AgglomeratingPreconditioner< TAlgebra >::clone(), ug::AgglomeratingPreconditioner< TAlgebra >::config_string(), and ug::AgglomeratingPreconditioner< TAlgebra >::init_agglomerated().

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

ugbase/lib_algebra/operator/linear_solver/agglomerating_solver.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ algebra_type

◆ base_type

◆ matrix_type

◆ vector_type

Constructor & Destructor Documentation

◆ AgglomeratingPreconditioner()

◆ ~AgglomeratingPreconditioner()

Member Function Documentation

◆ apply_agglomerated()

◆ clone()

◆ config_string()

◆ init_agglomerated()

◆ name()

◆ postprocess()

◆ preprocess()

◆ supports_parallel()

Member Data Documentation

◆ m_name

◆ m_splinIt