ug4
|
describes a linear iterator that is based on a matrix operator More...
#include <preconditioner.h>
Public Types | |
typedef TAlgebra | algebra_type |
Algebra type. | |
typedef MatrixOperator< matrix_type, vector_type > | matrix_operator_type |
Matrix Operator type. | |
typedef TAlgebra::matrix_type | matrix_type |
Matrix type. | |
typedef TAlgebra::vector_type | vector_type |
Vector type. | |
![]() | |
typedef TAlgebra::vector_type | codomain_function_type |
Range space. | |
typedef TAlgebra::vector_type | domain_function_type |
Domain space. | |
![]() | |
typedef TAlgebra | algebra_type |
type of algebra | |
typedef TAlgebra::matrix_type | matrix_type |
type of matrix | |
typedef TAlgebra::vector_type | vector_type |
type of vector | |
![]() | |
typedef TAlgebra::vector_type | vector_type |
type of vector | |
Public Member Functions | |
virtual bool | apply (vector_type &c, const vector_type &d) |
compute new correction c = B*d | |
virtual bool | apply_update_defect (vector_type &c, vector_type &d) |
compute new correction c = B*d and update defect d:= d - L*c | |
SmartPtr< MatrixOperator< matrix_type, vector_type > > | approx_operator () |
underlying matrix based operator used for the preconditioner | |
SmartPtr< MatrixOperator< matrix_type, vector_type > > | defect_operator () |
underlying matrix based operator for calculation of defect | |
virtual bool | init (SmartPtr< ILinearOperator< vector_type > > J, const vector_type &u) |
implements the ILinearIterator-interface for matrix based preconditioner | |
bool | init (SmartPtr< ILinearOperator< vector_type > > L) |
implements the ILinearIterator-interface for matrix based preconditioner | |
bool | init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op) |
initializes the preconditioner for a matrix based operator | |
IPreconditioner () | |
default constructor | |
IPreconditioner (const IPreconditioner< TAlgebra > &parent) | |
clone constructor | |
IPreconditioner (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter) | |
constructor setting debug writer | |
virtual void | set_approximation (SmartPtr< MatrixOperator< matrix_type, vector_type > > approx) |
virtual | ~IPreconditioner () |
virtual destructor | |
![]() | |
virtual SmartPtr< ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > > | clone ()=0 |
clone | |
virtual std::string | config_string () const |
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 bool | supports_parallel () const=0 |
returns if parallel solving is supported | |
virtual | ~ILinearIterator () |
virtual destructor | |
![]() | |
SmartPtr< IDebugWriter< algebra_type > > | debug_writer () |
returns the debug writer | |
ConstSmartPtr< IDebugWriter< algebra_type > > | debug_writer () const |
bool | debug_writer_valid () const |
returns true if the debug writer is set | |
DebugWritingObject () | |
DebugWritingObject (const DebugWritingObject< algebra_type > &parent) | |
clone constructor | |
DebugWritingObject (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter) | |
virtual void | set_debug (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter) |
set debug writer | |
virtual | ~DebugWritingObject () |
virtual destructor | |
![]() | |
virtual void | set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter) |
set debug writer | |
SmartPtr< IVectorDebugWriter< vector_type > > | vector_debug_writer () |
returns the debug writer | |
ConstSmartPtr< IVectorDebugWriter< vector_type > > | vector_debug_writer () const |
bool | vector_debug_writer_valid () const |
returns true if the debug writer is set | |
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) | |
virtual | ~VectorDebugWritingObject () |
virtual destructor | |
Protected Member Functions | |
virtual const char * | name () const =0 |
returns the name of iterator | |
virtual bool | postprocess ()=0 |
cleans the operator | |
virtual bool | preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)=0 |
initializes the preconditioner | |
virtual bool | step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d)=0 |
computes a new correction c = B*d | |
![]() | |
void | enter_debug_writer_section (const char *secDir) |
enters a debugging section | |
void | enter_debug_writer_section (std::string secDir) |
enters a debugging section | |
void | leave_debug_writer_section () |
leaves a debugging section | |
void | write_debug (const matrix_type &mat, const char *filename) |
write debug output for a matrix (if debug writer set) | |
void | write_debug (const matrix_type &mat, std::string name) |
write debug output for a matrix (if debug writer set) | |
![]() | |
void | enter_vector_debug_writer_section (const char *secDir) |
enters a debugging section | |
void | enter_vector_debug_writer_section (std::string secDir) |
enters a debugging section | |
void | leave_vector_debug_writer_section () |
leaves a debugging section | |
void | print_debugger_message (const char *msg) |
prints a debugger message (listing all the sections) | |
void | print_debugger_message (std::string msg) |
prints a debugger message (listing all the sections) | |
virtual void | write_debug (const vector_type &vec, std::string name) |
writing debug output for a vector (if debug writer set) | |
Protected Attributes | |
bool | m_bInit |
init flag indicating if init has been called | |
bool | m_bOtherApproxOperator |
SmartPtr< MatrixOperator< matrix_type, vector_type > > | m_spApproxOperator |
underlying matrix based operator used for the preconditioner | |
SmartPtr< ILinearOperator< vector_type > > | m_spDefectOperator |
underlying matrix based operator for calculation of defect | |
![]() | |
SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > | m_spDamping |
the scaling | |
![]() | |
SmartPtr< IDebugWriter< algebra_type > > | m_spDebugWriter |
Debug Writer. | |
![]() | |
SmartPtr< IVectorDebugWriter< vector_type > > | m_spVectorDebugWriter |
Debug Writer. | |
describes a linear iterator that is based on a matrix operator
This class is the base class for all linear iterators, that act on matrix based linear operators. We call the matrix based iterator a 'Preconditioner'. They are used in iterative schemes when solving a linear system. Usually, a linear problem like L*u = f is intended to be solved. This is done in an iterative way by performing an iteration of
start: compute d := f - L*u iterate: - c := B*d (compute correction)
This iterator class describes the application of B in the scheme above, where L is internally represented by a matrix.
This method derives from the ILinearIterator-interface and thus must implement these to steps:
This splitting has been made, since initialization may be computationally expansive. Thus, the user of this class has the choice when to call this initialization. E.g. when the operator is applied several times the init of the iterator is only needed once.
In order to facilitate the implementation of derived classes a default implementation of these virtual method is given. Thus, the implementational part for a matrix based iterator is to implement the three functions:
TAlgebra | Type of Algebra |
typedef TAlgebra ug::IPreconditioner< TAlgebra >::algebra_type |
Algebra type.
typedef MatrixOperator<matrix_type, vector_type> ug::IPreconditioner< TAlgebra >::matrix_operator_type |
Matrix Operator type.
typedef TAlgebra::matrix_type ug::IPreconditioner< TAlgebra >::matrix_type |
Matrix type.
typedef TAlgebra::vector_type ug::IPreconditioner< TAlgebra >::vector_type |
Vector type.
|
inline |
default constructor
|
inline |
constructor setting debug writer
|
inline |
clone constructor
|
inlinevirtual |
virtual destructor
|
inlinevirtual |
compute new correction c = B*d
This method implements the virtual method of the ILinearIterator-interface. Basically, besides some common checks the request is forwarded to the (virtual) 'step'-method.
[out] | c | correction |
[in] | d | defect |
Implements ug::ILinearIterator< TAlgebra::vector_type >.
Reimplemented in ug::Jacobi< TAlgebra >, and ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >.
References ug::ILinearIterator< TAlgebra::vector_type >::damping(), ug::IPreconditioner< TAlgebra >::m_bInit, ug::IPreconditioner< TAlgebra >::m_spApproxOperator, ug::IPreconditioner< TAlgebra >::name(), ug::PST_ADDITIVE, ug::PST_CONSISTENT, ug::IPreconditioner< TAlgebra >::step(), THROW_IF_NOT_EQUAL_4, UG_LOG, and UG_THROW.
Referenced by ug::IPreconditioner< TAlgebra >::apply_update_defect().
|
inlinevirtual |
compute new correction c = B*d and update defect d:= d - L*c
This method implements the virtual method of the ILinearIterator-interface. Basically, the request is forwarded to the 'apply'-method and then the update of the defect is computed afterwards.
[out] | c | correction |
[in,out] | d | defect on entry, updated defect on exit |
Implements ug::ILinearIterator< TAlgebra::vector_type >.
Reimplemented in ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >.
References ug::IPreconditioner< TAlgebra >::apply(), and ug::IPreconditioner< TAlgebra >::m_spDefectOperator.
|
inline |
underlying matrix based operator used for the preconditioner
References ug::IPreconditioner< TAlgebra >::m_spApproxOperator.
|
inline |
underlying matrix based operator for calculation of defect
References ug::IPreconditioner< TAlgebra >::m_spDefectOperator.
|
inlinevirtual |
implements the ILinearIterator-interface for matrix based preconditioner
This method implements the ILinearIterator interface. It check if the passed linear operator is matrix based (otherwise this preconditioner can not be used for the linear operator). Then the request is forwarded to the implementation of matrix based operators.
[in] | J | linear operator |
[in] | u | linearization point |
Reimplemented in ug::ILU< TAlgebra >, ug::ILUTPreconditioner< TAlgebra >, ug::ILUTPreconditioner< ug::CPUAlgebra >, and ug::UzawaBase< TDomain, TAlgebra >.
References init(), SmartPtr< T, FreePolicy >::invalid(), ug::IPreconditioner< TAlgebra >::name(), and UG_THROW.
Referenced by ug::ILU< TAlgebra >::init(), ug::UzawaBase< TDomain, TAlgebra >::init(), ug::ILU< TAlgebra >::init(), and ug::ILU< TAlgebra >::init().
|
inline |
implements the ILinearIterator-interface for matrix based preconditioner
This method implements the ILinearIterator interface. It check if the passed linear operator is matrix based (otherwise this preconditioner can not be used for the linear operator). Then the request is forwarded to the implementation of matrix based operators.
[in] | L | linear operator |
References init(), SmartPtr< T, FreePolicy >::invalid(), ug::IPreconditioner< TAlgebra >::m_bOtherApproxOperator, ug::IPreconditioner< TAlgebra >::m_spDefectOperator, ug::IPreconditioner< TAlgebra >::name(), and UG_THROW.
|
inline |
initializes the preconditioner for a matrix based operator
This method initializes the preconditioner for matrix based operators. It performs some default checks and then forwards internally the initialization to the (virtual) 'preprocess'-method
[in] | Op | matrix based operator |
References SmartPtr< T, FreePolicy >::invalid(), ug::IPreconditioner< TAlgebra >::m_bInit, ug::IPreconditioner< TAlgebra >::m_spApproxOperator, ug::IPreconditioner< TAlgebra >::m_spDefectOperator, ug::IPreconditioner< TAlgebra >::name(), ug::IPreconditioner< TAlgebra >::preprocess(), UG_LOG, and UG_THROW.
|
protectedpure virtual |
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
Implements ug::ILinearIterator< TAlgebra::vector_type >.
Implemented in ug::CRILUTPreconditioner< typename TAlgebra >, ug::PCRILUTPreconditioner< typename TAlgebra >, ug::AgglomeratingPreconditioner< TAlgebra >, ug::BlockGaussSeidel< TAlgebra, backward, forward >, ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >, ug::GaussSeidel< TAlgebra >, ug::BackwardGaussSeidel< TAlgebra >, ug::SymmetricGaussSeidel< TAlgebra >, ug::ILU< TAlgebra >, ug::ILUTPreconditioner< TAlgebra >, ug::ILUTPreconditioner< ug::CPUAlgebra >, ug::ILUTScalarPreconditioner< TAlgebra >, ug::ILUTScalarPreconditioner< algebra_type >, ug::Jacobi< TAlgebra >, ug::PILUTPreconditioner< TAlgebra >, ug::ProjGaussSeidel< TDomain, TAlgebra >, ug::ProjBackwardGaussSeidel< TDomain, TAlgebra >, ug::ProjSymmetricGaussSeidel< TDomain, TAlgebra >, ug::SchurPrecond< TAlgebra >, ug::Vanka< TAlgebra >, ug::DiagVanka< TAlgebra >, ug::ComponentGaussSeidel< TDomain, TAlgebra >, ug::ElementGaussSeidel< TDomain, TAlgebra >, ug::SequentialSubspaceCorrection< TDomain, TAlgebra >, ug::UzawaBase< TDomain, TAlgebra >, ug::LineGaussSeidel< TDomain, TAlgebra >, ug::LineVanka< TDomain, TAlgebra >, ug::GaussSeidelBase< TAlgebra >, and ug::IProjGaussSeidel< TDomain, TAlgebra >.
Referenced by ug::IPreconditioner< TAlgebra >::apply(), ug::IPreconditioner< TAlgebra >::init(), ug::IPreconditioner< TAlgebra >::init(), ug::IPreconditioner< TAlgebra >::init(), and ug::IPreconditioner< TAlgebra >::set_approximation().
|
protectedpure virtual |
cleans the operator
Implemented in ug::CRILUTPreconditioner< typename TAlgebra >, ug::PCRILUTPreconditioner< typename TAlgebra >, ug::AgglomeratingPreconditioner< TAlgebra >, ug::IBlockJacobiPreconditioner< TAlgebra >, ug::BlockGaussSeidel< TAlgebra, backward, forward >, ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >, ug::GaussSeidelBase< TAlgebra >, ug::ILU< TAlgebra >, ug::ILUTPreconditioner< TAlgebra >, ug::ILUTPreconditioner< ug::CPUAlgebra >, ug::ILUTScalarPreconditioner< TAlgebra >, ug::ILUTScalarPreconditioner< algebra_type >, ug::Jacobi< TAlgebra >, ug::PILUTPreconditioner< TAlgebra >, ug::SchurPrecond< TAlgebra >, ug::Vanka< TAlgebra >, ug::DiagVanka< TAlgebra >, ug::ComponentGaussSeidel< TDomain, TAlgebra >, ug::ElementGaussSeidel< TDomain, TAlgebra >, ug::SequentialSubspaceCorrection< TDomain, TAlgebra >, ug::UzawaBase< TDomain, TAlgebra >, ug::LineGaussSeidel< TDomain, TAlgebra >, and ug::LineVanka< TDomain, TAlgebra >.
|
protectedpure virtual |
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.
[in] | mat | underlying matrix (i.e. L in L*u = f) |
Implemented in ug::CRILUTPreconditioner< typename TAlgebra >, ug::PCRILUTPreconditioner< typename TAlgebra >, ug::IBlockJacobiPreconditioner< TAlgebra >, ug::GaussSeidelBase< TAlgebra >, ug::ILU< TAlgebra >, ug::ILUTPreconditioner< TAlgebra >, ug::ILUTPreconditioner< ug::CPUAlgebra >, ug::ILUTScalarPreconditioner< TAlgebra >, ug::ILUTScalarPreconditioner< algebra_type >, ug::Jacobi< TAlgebra >, ug::PILUTPreconditioner< TAlgebra >, ug::SchurPrecond< TAlgebra >, ug::Vanka< TAlgebra >, ug::DiagVanka< TAlgebra >, ug::ComponentGaussSeidel< TDomain, TAlgebra >, ug::ElementGaussSeidel< TDomain, TAlgebra >, ug::SequentialSubspaceCorrection< TDomain, TAlgebra >, ug::UzawaBase< TDomain, TAlgebra >, ug::LineGaussSeidel< TDomain, TAlgebra >, ug::LineVanka< TDomain, TAlgebra >, and ug::AgglomeratingPreconditioner< TAlgebra >.
Referenced by ug::IPreconditioner< TAlgebra >::init(), and ug::IPreconditioner< TAlgebra >::set_approximation().
|
inlinevirtual |
|
protectedpure virtual |
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.
[in] | mat | underlying matrix (i.e. L in L*u = f) |
[out] | c | correction |
[in] | d | defect |
Implemented in ug::CRILUTPreconditioner< typename TAlgebra >, ug::PCRILUTPreconditioner< typename TAlgebra >, ug::AgglomeratingBase< IPreconditioner< TAlgebra >, TAlgebra >, ug::IBlockJacobiPreconditioner< TAlgebra >, ug::GaussSeidelBase< TAlgebra >, ug::ILU< TAlgebra >, ug::ILUTPreconditioner< TAlgebra >, ug::ILUTPreconditioner< ug::CPUAlgebra >, ug::ILUTScalarPreconditioner< TAlgebra >, ug::ILUTScalarPreconditioner< algebra_type >, ug::Jacobi< TAlgebra >, ug::PILUTPreconditioner< TAlgebra >, ug::SchurPrecond< TAlgebra >, ug::Vanka< TAlgebra >, ug::DiagVanka< TAlgebra >, ug::ComponentGaussSeidel< TDomain, TAlgebra >, ug::ElementGaussSeidel< TDomain, TAlgebra >, ug::SequentialSubspaceCorrection< TDomain, TAlgebra >, ug::UzawaBase< TDomain, TAlgebra >, ug::LineGaussSeidel< TDomain, TAlgebra >, and ug::LineVanka< TDomain, TAlgebra >.
Referenced by ug::IPreconditioner< TAlgebra >::apply().
|
protected |
init flag indicating if init has been called
Referenced by ug::IPreconditioner< TAlgebra >::apply(), ug::Jacobi< TAlgebra >::apply(), and ug::IPreconditioner< TAlgebra >::init().
|
protected |
|
protected |
underlying matrix based operator used for the preconditioner
Referenced by ug::IPreconditioner< TAlgebra >::apply(), ug::IPreconditioner< TAlgebra >::approx_operator(), ug::IPreconditioner< TAlgebra >::init(), and ug::IPreconditioner< TAlgebra >::set_approximation().
|
protected |
underlying matrix based operator for calculation of defect
Referenced by ug::IPreconditioner< TAlgebra >::apply_update_defect(), ug::IPreconditioner< TAlgebra >::defect_operator(), ug::IPreconditioner< TAlgebra >::init(), and ug::IPreconditioner< TAlgebra >::init().