ug4
ug::AgglomeratingPreconditioner< TAlgebra > Class Template Reference

#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. More...
 
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. More...
 
typedef MatrixOperator< matrix_type, vector_typematrix_operator_type
 Matrix Operator type. More...
 
typedef TAlgebra::matrix_type matrix_type
 Matrix type. More...
 
typedef TAlgebra::vector_type vector_type
 Vector type. More...
 
- Public Types inherited from ug::ILinearIterator< TAlgebra::vector_type >
typedef TAlgebra::vector_type codomain_function_type
 Range space. More...
 
typedef TAlgebra::vector_type domain_function_type
 Domain space. More...
 
- Public Types inherited from ug::DebugWritingObject< TAlgebra >
typedef TAlgebra algebra_type
 type of algebra More...
 
typedef TAlgebra::matrix_type matrix_type
 type of matrix More...
 
typedef TAlgebra::vector_type vector_type
 type of vector More...
 
- Public Types inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
typedef TAlgebra::vector_type vector_type
 type of vector More...
 

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. More...
 
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 More...
 
virtual bool postprocess ()
 cleans the operator More...
 
virtual bool preprocess (SmartPtr< MatrixOperator< typename TAlgebra::matrix_type, typename TAlgebra::vector_type > > pOp)
 initializes the preconditioner More...
 
virtual bool supports_parallel () const
 returns if parallel solving is supported More...
 
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. More...
 
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 ()
 
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 More...
 
SmartPtr< MatrixOperator< matrix_type, vector_type > > defect_operator ()
 underlying matrix based operator for calculation of defect More...
 
virtual bool init (SmartPtr< ILinearOperator< vector_type > > J, const vector_type &u)
 implements the ILinearIterator-interface for matrix based preconditioner More...
 
bool init (SmartPtr< ILinearOperator< vector_type > > L)
 implements the ILinearIterator-interface for matrix based preconditioner More...
 
bool init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op)
 initializes the preconditioner for a matrix based operator More...
 
 IPreconditioner ()
 default constructor More...
 
 IPreconditioner (const IPreconditioner< TAlgebra > &parent)
 clone constructor More...
 
 IPreconditioner (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
 constructor setting debug writer More...
 
virtual void set_approximation (SmartPtr< MatrixOperator< matrix_type, vector_type > > approx)
 
virtual ~IPreconditioner ()
 virtual destructor More...
 
- Public Member Functions inherited from ug::ILinearIterator< TAlgebra::vector_type >
SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > damping ()
 returns the scaling More...
 
 ILinearIterator ()
 constructor More...
 
 ILinearIterator (const ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > &parent)
 copy constructor More...
 
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 More...
 
virtual bool init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > L)=0
 initialize for linear operator L More...
 
void set_damp (number factor)
 sets the damping to a constant factor More...
 
void set_damp (SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > spScaling)
 sets a scaling for the correction More...
 
virtual ~ILinearIterator ()
 virtual destructor More...
 
- Public Member Functions inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > > debug_writer ()
 returns the debug writer More...
 
ConstSmartPtr< IDebugWriter< algebra_type > > debug_writer () const
 
bool debug_writer_valid () const
 returns true if the debug writer is set More...
 
 DebugWritingObject ()
 
 DebugWritingObject (const DebugWritingObject< algebra_type > &parent)
 clone constructor More...
 
 DebugWritingObject (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
 
virtual void set_debug (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
 set debug writer More...
 
virtual ~DebugWritingObject ()
 virtual destructor More...
 
- Public Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
virtual void set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)
 set debug writer More...
 
SmartPtr< IVectorDebugWriter< vector_type > > vector_debug_writer ()
 returns the debug writer More...
 
ConstSmartPtr< IVectorDebugWriter< vector_type > > vector_debug_writer () const
 
bool vector_debug_writer_valid () const
 returns true if the debug writer is set More...
 
 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) More...
 
virtual ~VectorDebugWritingObject ()
 virtual destructor More...
 

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_typem_pMatrix
 
SmartPtr< MatrixOperator< matrix_type, vector_type > > m_spCollectedOp
 
SmartPtr< AlgebraLayoutsm_spLocalAlgebraLayouts
 
- Protected Attributes inherited from ug::IPreconditioner< TAlgebra >
bool m_bInit
 init flag indicating if init has been called More...
 
bool m_bOtherApproxOperator
 
SmartPtr< MatrixOperator< matrix_type, vector_type > > m_spApproxOperator
 underlying matrix based operator used for the preconditioner More...
 
SmartPtr< ILinearOperator< vector_type > > m_spDefectOperator
 underlying matrix based operator for calculation of defect More...
 
- Protected Attributes inherited from ug::ILinearIterator< TAlgebra::vector_type >
SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > m_spDamping
 the scaling More...
 
- Protected Attributes inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > > m_spDebugWriter
 Debug Writer. More...
 
- Protected Attributes inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
SmartPtr< IVectorDebugWriter< vector_type > > m_spVectorDebugWriter
 Debug Writer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ug::DebugWritingObject< TAlgebra >
void enter_debug_writer_section (const char *secDir)
 enters a debugging section More...
 
void enter_debug_writer_section (std::string secDir)
 enters a debugging section More...
 
void leave_debug_writer_section ()
 leaves a debugging section More...
 
void write_debug (const matrix_type &mat, const char *filename)
 write debug output for a matrix (if debug writer set) More...
 
void write_debug (const matrix_type &mat, std::string name)
 write debug output for a matrix (if debug writer set) More...
 
- Protected Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
void enter_vector_debug_writer_section (const char *secDir)
 enters a debugging section More...
 
void enter_vector_debug_writer_section (std::string secDir)
 enters a debugging section More...
 
void leave_vector_debug_writer_section ()
 leaves a debugging section More...
 
void print_debugger_message (const char *msg)
 prints a debugger message (listing all the sections) More...
 
void print_debugger_message (std::string msg)
 prints a debugger message (listing all the sections) More...
 
virtual void write_debug (const vector_type &vec, std::string name)
 writing debug output for a vector (if debug writer set) More...
 

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()

◆ ~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

◆ clone()

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

◆ config_string()

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

◆ init_agglomerated()

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

◆ 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]matunderlying 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

◆ m_splinIt


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