ug4
ug::ElementGaussSeidel< TDomain, TAlgebra > Class Template Reference

ElementGaussSeidel Preconditioner. More...

#include <element_gauss_seidel.h>

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

Public Types

typedef TAlgebra algebra_type
 Algebra type. More...
 
typedef IPreconditioner< TAlgebra > base_type
 Base type. More...
 
typedef IPreconditioner< TAlgebra >::matrix_operator_type matrix_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::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...
 
 ElementGaussSeidel ()
 default constructor More...
 
 ElementGaussSeidel (const std::string &type)
 constructor setting type More...
 
 ElementGaussSeidel (number relax)
 constructor setting relaxation More...
 
 ElementGaussSeidel (number relax, const std::string &type)
 constructor setting relaxation and type More...
 
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 More...
 
void set_type (const std::string &type)
 set type More...
 
virtual bool supports_parallel () const
 returns if parallel solving is supported More...
 
virtual ~ElementGaussSeidel ()
 Destructor. More...
 
- 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 >
virtual std::string config_string () const
 
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 Types

typedef GridFunction< TDomain, TAlgebra > grid_function_type
 

Protected Member Functions

virtual const char * name () const
 Name of preconditioner. More...
 
virtual bool postprocess ()
 Postprocess routine. More...
 
virtual bool preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)
 Preprocess routine. 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...
 

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

◆ 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

◆ 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

◆ set_elim_offdiag()

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

◆ 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, and omega.

◆ set_type()

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

◆ 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]matunderlying matrix (i.e. L in L*u = f)
[out]ccorrection
[in]ddefect
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

◆ m_elim_off_diag

template<typename TDomain , typename TAlgebra >
bool ug::ElementGaussSeidel< TDomain, TAlgebra >::m_elim_off_diag
protected

◆ m_relax

◆ m_schur_alpha

◆ m_schur_cmp

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

◆ m_type

template<typename TDomain , typename TAlgebra >
std::string ug::ElementGaussSeidel< TDomain, TAlgebra >::m_type
protected

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