ug4
ug::SparseBlockGaussSeidel< TAlgebra, backward, forward > Class Template Reference

#include <block_gauss_seidel.h>

+ Inheritance diagram for ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >:

Public Types

typedef TAlgebra algebra_type
 
typedef IBlockJacobiPreconditioner< TAlgebra > base_type
 Base type. More...
 
typedef matrix_type::const_row_iterator const_row_iterator
 
typedef IPreconditioner< TAlgebra >::matrix_operator_type matrix_operator_type
 Matrix Operator type. More...
 
typedef TAlgebra::matrix_type matrix_type
 
typedef matrix_type::value_type smallmat_type
 
typedef vector_type::value_type smallvec_type
 
typedef TAlgebra::vector_type vector_type
 
- Public Types inherited from ug::IBlockJacobiPreconditioner< TAlgebra >
typedef TAlgebra algebra_type
 
typedef IPreconditioner< TAlgebra >::matrix_operator_type matrix_operator_type
 Matrix Operator type. More...
 
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

virtual SmartPtr< ILinearIterator< vector_type > > clone ()
 clone More...
 
void set_depth (size_t d)
 
 SparseBlockGaussSeidel ()
 
 SparseBlockGaussSeidel (const this_type &parent)
 
 SparseBlockGaussSeidel (int depth)
 
- Public Member Functions inherited from ug::IBlockJacobiPreconditioner< TAlgebra >
 IBlockJacobiPreconditioner ()
 
 IBlockJacobiPreconditioner (const IBlockJacobiPreconditioner &parent)
 
- Public Member Functions inherited from ug::IPreconditioner< TAlgebra >
virtual bool apply (vector_type &c, const vector_type &d)
 compute new correction c = B*d More...
 
virtual bool apply_update_defect (vector_type &c, vector_type &d)
 compute new correction c = B*d and update defect d:= d - L*c More...
 
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...
 

Public Attributes

std::map< size_t, SmartPtr< CPUAlgebra::matrix_type > > Aloc
 
std::vector< std::vector< size_t > > indices
 
size_t m_depth
 
std::map< size_t, SmartPtr< ILUTPreconditioner< CPUAlgebra > > > m_ilut
 

Protected Types

typedef matrix_type::value_type block_type
 
typedef matrix_type::const_row_iterator matrix_const_row_iterator
 
typedef matrix_type::row_iterator matrix_row_iterator
 
typedef SparseBlockGaussSeidel< TAlgebra, backward, forward > this_type
 

Protected Member Functions

virtual bool block_preprocess (matrix_type &A)
 
virtual bool block_step (matrix_type &A, vector_type &c, const vector_type &d)
 
virtual std::string config_string () const
 
virtual const char * name () const
 returns the name of iterator More...
 
virtual bool postprocess ()
 cleans the operator More...
 
virtual bool supports_parallel () const
 returns if parallel solving is supported More...
 
- Protected Member Functions inherited from ug::IBlockJacobiPreconditioner< TAlgebra >
virtual bool preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)
 initializes the preconditioner More...
 
virtual bool step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d)
 computes a new correction c = B*d More...
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from ug::IBlockJacobiPreconditioner< TAlgebra >
matrix_type A
 
SmartPtr< vector_typem_spDtmp
 
- 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...
 

Detailed Description

template<typename TAlgebra, bool backward, bool forward>
class ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >

SparseBlockGaussSeidel experimental version a) can use bigger stencils since it uses SparseLU for solving blocks b) tries to use some overlapping blocks (BlockGaussSeidel always uses N blocks)

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra , bool backward, bool forward>
typedef TAlgebra ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::algebra_type

◆ base_type

template<typename TAlgebra , bool backward, bool forward>
typedef IBlockJacobiPreconditioner<TAlgebra> ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::base_type

Base type.

◆ block_type

template<typename TAlgebra , bool backward, bool forward>
typedef matrix_type::value_type ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::block_type
protected

◆ const_row_iterator

template<typename TAlgebra , bool backward, bool forward>
typedef matrix_type::const_row_iterator ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::const_row_iterator

◆ matrix_const_row_iterator

template<typename TAlgebra , bool backward, bool forward>
typedef matrix_type::const_row_iterator ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::matrix_const_row_iterator
protected

◆ matrix_operator_type

template<typename TAlgebra , bool backward, bool forward>
typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::matrix_operator_type

Matrix Operator type.

◆ matrix_row_iterator

template<typename TAlgebra , bool backward, bool forward>
typedef matrix_type::row_iterator ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::matrix_row_iterator
protected

◆ matrix_type

template<typename TAlgebra , bool backward, bool forward>
typedef TAlgebra::matrix_type ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::matrix_type

◆ smallmat_type

template<typename TAlgebra , bool backward, bool forward>
typedef matrix_type::value_type ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::smallmat_type

◆ smallvec_type

template<typename TAlgebra , bool backward, bool forward>
typedef vector_type::value_type ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::smallvec_type

◆ this_type

template<typename TAlgebra , bool backward, bool forward>
typedef SparseBlockGaussSeidel<TAlgebra, backward, forward> ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::this_type
protected

◆ vector_type

template<typename TAlgebra , bool backward, bool forward>
typedef TAlgebra::vector_type ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::vector_type

Constructor & Destructor Documentation

◆ SparseBlockGaussSeidel() [1/3]

template<typename TAlgebra , bool backward, bool forward>
ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::SparseBlockGaussSeidel ( )
inline

◆ SparseBlockGaussSeidel() [2/3]

template<typename TAlgebra , bool backward, bool forward>
ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::SparseBlockGaussSeidel ( int  depth)
inline

◆ SparseBlockGaussSeidel() [3/3]

template<typename TAlgebra , bool backward, bool forward>
ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::SparseBlockGaussSeidel ( const this_type parent)
inline

Member Function Documentation

◆ block_preprocess()

◆ block_step()

◆ clone()

template<typename TAlgebra , bool backward, bool forward>
virtual SmartPtr<ILinearIterator<vector_type> > ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::clone ( )
inlinevirtual

◆ config_string()

template<typename TAlgebra , bool backward, bool forward>
virtual std::string ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::config_string ( ) const
inlineprotectedvirtual

◆ name()

template<typename TAlgebra , bool backward, bool forward>
virtual const char* ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::name ( ) const
inlineprotectedvirtual

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

◆ postprocess()

template<typename TAlgebra , bool backward, bool forward>
virtual bool ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::postprocess ( )
inlineprotectedvirtual

cleans the operator

Reimplemented from ug::IBlockJacobiPreconditioner< TAlgebra >.

◆ set_depth()

template<typename TAlgebra , bool backward, bool forward>
void ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::set_depth ( size_t  d)
inline

◆ supports_parallel()

template<typename TAlgebra , bool backward, bool forward>
virtual bool ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::supports_parallel ( ) const
inlineprotectedvirtual

returns if parallel solving is supported

Reimplemented from ug::IBlockJacobiPreconditioner< TAlgebra >.

Member Data Documentation

◆ Aloc

template<typename TAlgebra , bool backward, bool forward>
std::map<size_t, SmartPtr<CPUAlgebra::matrix_type> > ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::Aloc

◆ indices

template<typename TAlgebra , bool backward, bool forward>
std::vector<std::vector<size_t> > ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::indices

◆ m_depth

◆ m_ilut

template<typename TAlgebra , bool backward, bool forward>
std::map<size_t, SmartPtr<ILUTPreconditioner<CPUAlgebra> > > ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::m_ilut

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