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

#include <line_smoothers.h>

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

Public Types

typedef TAlgebra algebra_type
 
typedef IPreconditioner< TAlgebra > base_type
 Base type. More...
 
typedef TDomain domain_type
 Domain. More...
 
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...
 
size_t get_num_backwardx ()
 
size_t get_num_backwardy ()
 
size_t get_num_backwardz ()
 
size_t get_num_forwardx ()
 
size_t get_num_forwardy ()
 
size_t get_num_forwardz ()
 
 LineVanka (SmartPtr< ApproximationSpace< TDomain > > approxSpace)
 
number relax ()
 
void set_num_steps (size_t forwardx, size_t backwardx)
 
void set_num_steps (size_t forwardx, size_t backwardx, size_t forwardy, size_t backwardy)
 
void set_num_steps (size_t forwardx, size_t backwardx, size_t forwardy, size_t backwardy, size_t forwardz, size_t backwardz)
 
void set_relax (number omega)
 set m_relaxation parameter More...
 
virtual bool supports_parallel () const
 returns if parallel solving is supported More...
 
bool update (size_t xsize)
 
 ~LineVanka ()
 
- 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 Member Functions

bool linevanka_step (const matrix_type &A, vector_type &x, const vector_type &b)
 
virtual const char * name () const
 returns the name of iterator More...
 
virtual bool postprocess ()
 cleans the operator More...
 
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...
 

Protected Attributes

std::vector< size_t > indY
 
std::vector< size_t > indZ
 
matrix_type m_A
 
size_t m_ind_end
 
bool m_init
 
size_t m_nr_backwardx
 
size_t m_nr_backwardy
 
size_t m_nr_backwardz
 
size_t m_nr_forwardx
 
size_t m_nr_forwardy
 
size_t m_nr_forwardz
 
number m_relax
 
SmartPtr< ApproximationSpace< TDomain > > m_spApproxSpace
 
- 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...
 

Static Protected Attributes

static const int dim = domain_type::dim
 world dimension More...
 

Member Typedef Documentation

◆ algebra_type

template<typename TDomain , typename TAlgebra >
typedef TAlgebra ug::LineVanka< TDomain, TAlgebra >::algebra_type

◆ base_type

template<typename TDomain , typename TAlgebra >
typedef IPreconditioner<TAlgebra> ug::LineVanka< TDomain, TAlgebra >::base_type

Base type.

◆ domain_type

template<typename TDomain , typename TAlgebra >
typedef TDomain ug::LineVanka< TDomain, TAlgebra >::domain_type

◆ matrix_operator_type

template<typename TDomain , typename TAlgebra >
typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::LineVanka< TDomain, TAlgebra >::matrix_operator_type

Matrix Operator type.

◆ matrix_type

template<typename TDomain , typename TAlgebra >
typedef TAlgebra::matrix_type ug::LineVanka< TDomain, TAlgebra >::matrix_type

◆ vector_type

template<typename TDomain , typename TAlgebra >
typedef TAlgebra::vector_type ug::LineVanka< TDomain, TAlgebra >::vector_type

Constructor & Destructor Documentation

◆ LineVanka()

◆ ~LineVanka()

template<typename TDomain , typename TAlgebra >
ug::LineVanka< TDomain, TAlgebra >::~LineVanka ( )
inline

Member Function Documentation

◆ clone()

◆ get_num_backwardx()

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::get_num_backwardx ( )
inline

◆ get_num_backwardy()

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::get_num_backwardy ( )
inline

◆ get_num_backwardz()

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::get_num_backwardz ( )
inline

◆ get_num_forwardx()

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::get_num_forwardx ( )
inline

◆ get_num_forwardy()

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::get_num_forwardy ( )
inline

◆ get_num_forwardz()

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::get_num_forwardz ( )
inline

◆ linevanka_step()

◆ name()

template<typename TDomain , typename TAlgebra >
virtual const char* ug::LineVanka< TDomain, TAlgebra >::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 TDomain , typename TAlgebra >
virtual bool ug::LineVanka< TDomain, TAlgebra >::postprocess ( )
inlineprotectedvirtual

cleans the operator

Implements ug::IPreconditioner< TAlgebra >.

◆ preprocess()

template<typename TDomain , typename TAlgebra >
virtual bool ug::LineVanka< TDomain, TAlgebra >::preprocess ( SmartPtr< MatrixOperator< matrix_type, vector_type > >  pOp)
inlineprotectedvirtual

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 pcl::CollectUniqueElements(), ug::LineVanka< TDomain, TAlgebra >::m_A, ug::MakeConsistent(), pcl::NumProcs(), and ug::SetDirichletRow().

◆ relax()

template<typename TDomain , typename TAlgebra >
number ug::LineVanka< TDomain, TAlgebra >::relax ( )
inline

◆ set_num_steps() [1/3]

◆ set_num_steps() [2/3]

template<typename TDomain , typename TAlgebra >
void ug::LineVanka< TDomain, TAlgebra >::set_num_steps ( size_t  forwardx,
size_t  backwardx,
size_t  forwardy,
size_t  backwardy 
)
inline

◆ set_num_steps() [3/3]

template<typename TDomain , typename TAlgebra >
void ug::LineVanka< TDomain, TAlgebra >::set_num_steps ( size_t  forwardx,
size_t  backwardx,
size_t  forwardy,
size_t  backwardy,
size_t  forwardz,
size_t  backwardz 
)
inline

◆ set_relax()

template<typename TDomain , typename TAlgebra >
void ug::LineVanka< TDomain, TAlgebra >::set_relax ( number  omega)
inline

set m_relaxation parameter

References ug::LineVanka< TDomain, TAlgebra >::m_relax, and omega.

◆ step()

template<typename TDomain , typename TAlgebra >
virtual bool ug::LineVanka< 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::LineVanka< TDomain, TAlgebra >::linevanka_step(), ug::LineVanka< TDomain, TAlgebra >::m_A, pcl::NumProcs(), and ug::PST_UNIQUE.

◆ supports_parallel()

template<typename TDomain , typename TAlgebra >
virtual bool ug::LineVanka< TDomain, TAlgebra >::supports_parallel ( ) const
inlinevirtual

returns if parallel solving is supported

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

◆ update()

Member Data Documentation

◆ dim

template<typename TDomain , typename TAlgebra >
const int ug::LineVanka< TDomain, TAlgebra >::dim = domain_type::dim
staticprotected

◆ indY

template<typename TDomain , typename TAlgebra >
std::vector<size_t> ug::LineVanka< TDomain, TAlgebra >::indY
protected

◆ indZ

template<typename TDomain , typename TAlgebra >
std::vector<size_t> ug::LineVanka< TDomain, TAlgebra >::indZ
protected

◆ m_A

template<typename TDomain , typename TAlgebra >
matrix_type ug::LineVanka< TDomain, TAlgebra >::m_A
protected

◆ m_ind_end

template<typename TDomain , typename TAlgebra >
size_t ug::LineVanka< TDomain, TAlgebra >::m_ind_end
protected

◆ m_init

template<typename TDomain , typename TAlgebra >
bool ug::LineVanka< TDomain, TAlgebra >::m_init
protected

◆ m_nr_backwardx

◆ m_nr_backwardy

◆ m_nr_backwardz

◆ m_nr_forwardx

◆ m_nr_forwardy

◆ m_nr_forwardz

◆ m_relax

◆ m_spApproxSpace

template<typename TDomain , typename TAlgebra >
SmartPtr<ApproximationSpace<TDomain> > ug::LineVanka< TDomain, TAlgebra >::m_spApproxSpace
protected

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