ug4
|
#include <block_gauss_seidel.h>
Public Types | |
typedef TAlgebra | algebra_type |
typedef IPreconditioner< TAlgebra >::matrix_operator_type | matrix_operator_type |
Matrix Operator type. | |
typedef TAlgebra::matrix_type | matrix_type |
typedef TAlgebra::vector_type | vector_type |
![]() | |
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 | |
IBlockJacobiPreconditioner () | |
IBlockJacobiPreconditioner (const IBlockJacobiPreconditioner &parent) | |
![]() | |
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 | ~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 bool | block_preprocess (matrix_type &A)=0 |
virtual bool | block_step (matrix_type &A, vector_type &c, const vector_type &d)=0 |
virtual bool | postprocess () |
cleans the operator | |
virtual bool | preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp) |
initializes the preconditioner | |
virtual bool | step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d) |
computes a new correction c = B*d | |
virtual bool | supports_parallel () const |
returns if parallel solving is supported | |
![]() | |
virtual const char * | name () const =0 |
returns the name of iterator | |
![]() | |
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 | |
matrix_type | A |
SmartPtr< vector_type > | m_spDtmp |
![]() | |
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. | |
typedef TAlgebra ug::IBlockJacobiPreconditioner< TAlgebra >::algebra_type |
typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::IBlockJacobiPreconditioner< TAlgebra >::matrix_operator_type |
Matrix Operator type.
typedef TAlgebra::matrix_type ug::IBlockJacobiPreconditioner< TAlgebra >::matrix_type |
typedef TAlgebra::vector_type ug::IBlockJacobiPreconditioner< TAlgebra >::vector_type |
|
inline |
|
inline |
|
protectedpure virtual |
Implemented in ug::BlockGaussSeidel< TAlgebra, backward, forward >, ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >, and ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >.
Referenced by ug::IBlockJacobiPreconditioner< TAlgebra >::preprocess().
|
protectedpure virtual |
Implemented in ug::BlockGaussSeidel< TAlgebra, backward, forward >, ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >, and ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >.
Referenced by ug::IBlockJacobiPreconditioner< TAlgebra >::step().
|
inlineprotectedvirtual |
cleans the operator
Implements ug::IPreconditioner< TAlgebra >.
Reimplemented in ug::BlockGaussSeidel< TAlgebra, backward, forward >, ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >, and ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >.
|
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.
[in] | mat | underlying matrix (i.e. L in L*u = f) |
Implements ug::IPreconditioner< TAlgebra >.
References ug::IBlockJacobiPreconditioner< TAlgebra >::A, ug::IBlockJacobiPreconditioner< TAlgebra >::block_preprocess(), ug::MatAddSlaveRowsToMasterRowOverlap0(), and ug::SetDirichletRow().
|
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.
[in] | mat | underlying matrix (i.e. L in L*u = f) |
[out] | c | correction |
[in] | d | defect |
Implements ug::IPreconditioner< TAlgebra >.
References ug::IBlockJacobiPreconditioner< TAlgebra >::A, ug::IBlockJacobiPreconditioner< TAlgebra >::block_step(), ug::IBlockJacobiPreconditioner< TAlgebra >::m_spDtmp, ug::PST_ADDITIVE, ug::PST_CONSISTENT, ug::PST_UNIQUE, and SmartPtr< T, FreePolicy >::valid().
|
inlineprotectedvirtual |
returns if parallel solving is supported
Implements ug::ILinearIterator< TAlgebra::vector_type >.
Reimplemented in ug::BlockGaussSeidel< TAlgebra, backward, forward >, ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >, ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >, and ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >.
|
protected |
Referenced by ug::BlockGaussSeidel< TAlgebra, backward, forward >::block_preprocess(), ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >::block_preprocess(), ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::block_preprocess(), ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >::block_preprocess(), ug::BlockGaussSeidel< TAlgebra, backward, forward >::block_step(), ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >::block_step(), ug::SparseBlockGaussSeidel< TAlgebra, backward, forward >::block_step(), ug::SparseBlockGaussSeidel2< TAlgebra, backward, forward >::block_step(), ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >::correct(), ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >::correct_backward(), ug::BlockGaussSeidelIterative< TAlgebra, backward, forward >::correct_forward(), ug::IBlockJacobiPreconditioner< TAlgebra >::preprocess(), and ug::IBlockJacobiPreconditioner< TAlgebra >::step().
|
protected |
Referenced by ug::IBlockJacobiPreconditioner< TAlgebra >::step().