#include <agglomerating_solver.h>

Inheritance diagram for ug::AgglomeratingIterator< TAlgebra >:

Public Types
typedef TAlgebra	algebra_type

typedef AgglomeratingBase< ILinearIterator< vector_type >, algebra_type >	base_type
	Base type.

typedef TAlgebra::matrix_type	matrix_type

typedef TAlgebra::vector_type	vector_type

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

typedef TAlgebra::matrix_type	matrix_type

typedef TAlgebra::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 Member Functions
	AgglomeratingIterator (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 (SmartPtr< ILinearOperator< vector_type > > A)

virtual bool	init (SmartPtr< ILinearOperator< vector_type > > A, const vector_type &u)

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

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

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

virtual	~AgglomeratingIterator ()

Public Member Functions inherited from ug::AgglomeratingBase< ILinearIterator< TAlgebra::vector_type >, 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::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

Protected Attributes
std::string	m_name

SmartPtr< ILinearIterator< vector_type > >	m_splinIt

Protected Attributes inherited from ug::AgglomeratingBase< ILinearIterator< TAlgebra::vector_type >, 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::ILinearIterator< TAlgebra::vector_type >
SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > >	m_spDamping
	the scaling

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >

typedef TAlgebra ug::AgglomeratingIterator< TAlgebra >::algebra_type

◆ base_type

template<typename TAlgebra >

typedef AgglomeratingBase<ILinearIterator<vector_type>, algebra_type > ug::AgglomeratingIterator< TAlgebra >::base_type

Base type.

◆ matrix_type

template<typename TAlgebra >

typedef TAlgebra::matrix_type ug::AgglomeratingIterator< TAlgebra >::matrix_type

◆ vector_type

template<typename TAlgebra >

typedef TAlgebra::vector_type ug::AgglomeratingIterator< TAlgebra >::vector_type

Constructor & Destructor Documentation

◆ AgglomeratingIterator()

template<typename TAlgebra >

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

inline

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

◆ ~AgglomeratingIterator()

template<typename TAlgebra >

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

inlinevirtual

Member Function Documentation

◆ apply_agglomerated()

template<typename TAlgebra >

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

inlinevirtual

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

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

◆ clone()

template<typename TAlgebra >

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

inlinevirtual

Clone.

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

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

◆ config_string()

template<typename TAlgebra >

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

inlinevirtual

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

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

◆ init() [1/2]

template<typename TAlgebra >

virtual bool ug::AgglomeratingIterator< TAlgebra >::init ( SmartPtr< ILinearOperator< vector_type > > A )

inlinevirtual

◆ init() [2/2]

template<typename TAlgebra >

virtual bool ug::AgglomeratingIterator< TAlgebra >::init	(	SmartPtr< ILinearOperator< vector_type > >	A,
		const vector_type &	u
	)

inlinevirtual

◆ init_agglomerated()

template<typename TAlgebra >

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

inlinevirtual

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

◆ name()

template<typename TAlgebra >

virtual const char * ug::AgglomeratingIterator< 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::ILinearIterator< TAlgebra::vector_type >.

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

◆ supports_parallel()

template<typename TAlgebra >

virtual bool ug::AgglomeratingIterator< 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::AgglomeratingIterator< TAlgebra >::m_name

protected

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

◆ m_splinIt

template<typename TAlgebra >

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

protected

Referenced by ug::AgglomeratingIterator< TAlgebra >::AgglomeratingIterator(), ug::AgglomeratingIterator< TAlgebra >::apply_agglomerated(), ug::AgglomeratingIterator< TAlgebra >::clone(), ug::AgglomeratingIterator< TAlgebra >::config_string(), and ug::AgglomeratingIterator< 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

Member Typedef Documentation

◆ algebra_type

◆ base_type

◆ matrix_type

◆ vector_type

Constructor & Destructor Documentation

◆ AgglomeratingIterator()

◆ ~AgglomeratingIterator()

Member Function Documentation

◆ apply_agglomerated()

◆ clone()

◆ config_string()

◆ init() [1/2]

◆ init() [2/2]

◆ init_agglomerated()

◆ name()

◆ supports_parallel()

Member Data Documentation

◆ m_name

◆ m_splinIt