ug4
|
#include <ilut.h>
Public Types | |
typedef TAlgebra | algebra_type |
typedef matrix_type::const_row_iterator | const_matrix_row_iterator |
typedef matrix_type::connection | matrix_connection |
typedef IPreconditioner< TAlgebra >::matrix_operator_type | matrix_operator_type |
Matrix Operator type. More... | |
typedef matrix_type::row_iterator | matrix_row_iterator |
typedef TAlgebra::matrix_type | matrix_type |
typedef IOrderingAlgorithm< TAlgebra, ordering_container_type > | ordering_algo_type |
typedef std::vector< size_t > | ordering_container_type |
Ordering type. More... | |
typedef TAlgebra::vector_type | vector_type |
typedef vector_type::value_type | vector_value |
Public Types inherited from ug::IPreconditioner< TAlgebra > | |
typedef TAlgebra | algebra_type |
Algebra type. More... | |
typedef MatrixOperator< matrix_type, vector_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::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 bool | applyLU (vector_type &c, const vector_type &d) |
virtual SmartPtr< ILinearIterator< vector_type > > | clone () |
Clone. More... | |
virtual std::string | config_string () const |
ILUTPreconditioner (const ILUTPreconditioner< TAlgebra > &parent) | |
clone constructor More... | |
ILUTPreconditioner (double eps=1e-6) | |
Constructor. More... | |
virtual bool | multi_apply (std::vector< vector_type > &vc, const std::vector< vector_type > &vd) |
virtual bool | postprocess () |
cleans the operator More... | |
virtual bool | preprocess_mat (matrix_type &mat) |
virtual bool | preprocess_mat2 (matrix_type &mat) |
void | set_info (bool info) |
sets storage information output to true or false More... | |
void | set_ordering_algorithm (SmartPtr< ordering_algo_type > ordering_algo) |
sets an ordering algorithm More... | |
void | set_show_progress (bool s) |
set whether the progress meter should be shown More... | |
void | set_sort (bool b) |
set cuthill-mckee sort on/off More... | |
void | set_threshold (number thresh) |
sets threshold for incomplete LU factorisation (added 01122010ih) More... | |
virtual bool | solve (vector_type &c, const vector_type &d) |
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... | |
virtual bool | supports_parallel () const |
returns if parallel solving is supported More... | |
virtual | ~ILUTPreconditioner () |
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... | |
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... | |
Protected Types | |
typedef matrix_type::value_type | block_type |
Protected Member Functions | |
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) |
bool | init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op) |
virtual const char * | name () const |
returns the name of iterator More... | |
virtual bool | preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp) |
initializes the preconditioner 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... | |
Static Protected Attributes | |
static const number | m_small = 1e-8 |
Private Types | |
typedef IPreconditioner< TAlgebra > | base_type |
typedef TAlgebra ug::ILUTPreconditioner< TAlgebra >::algebra_type |
|
private |
|
protected |
typedef matrix_type::const_row_iterator ug::ILUTPreconditioner< TAlgebra >::const_matrix_row_iterator |
typedef matrix_type::connection ug::ILUTPreconditioner< TAlgebra >::matrix_connection |
typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::ILUTPreconditioner< TAlgebra >::matrix_operator_type |
Matrix Operator type.
typedef matrix_type::row_iterator ug::ILUTPreconditioner< TAlgebra >::matrix_row_iterator |
typedef TAlgebra::matrix_type ug::ILUTPreconditioner< TAlgebra >::matrix_type |
typedef IOrderingAlgorithm<TAlgebra, ordering_container_type> ug::ILUTPreconditioner< TAlgebra >::ordering_algo_type |
typedef std::vector<size_t> ug::ILUTPreconditioner< TAlgebra >::ordering_container_type |
Ordering type.
typedef TAlgebra::vector_type ug::ILUTPreconditioner< TAlgebra >::vector_type |
typedef vector_type::value_type ug::ILUTPreconditioner< TAlgebra >::vector_value |
|
inline |
Constructor.
References ug::ILUTPreconditioner< TAlgebra >::m_spOrderingAlgo, and make_sp().
|
inline |
|
inlinevirtual |
Destructor.
|
inlinevirtual |
References ug::BlockNorm(), ug::InverseMatMult(), ug::ILUTPreconditioner< TAlgebra >::m_eps, ug::ILUTPreconditioner< TAlgebra >::m_L, ug::ILUTPreconditioner< TAlgebra >::m_small, ug::ILUTPreconditioner< TAlgebra >::m_U, ug::MatMultAdd(), PROFILE_BEGIN_GROUP, s, UG_ASSERT, and UG_LOG.
Referenced by ug::ILUTPreconditioner< TAlgebra >::solve().
|
inlinevirtual |
|
inlinevirtual |
Reimplemented from ug::ILinearIterator< TAlgebra::vector_type >.
References ug::ILUTPreconditioner< TAlgebra >::m_eps, and ug::ILUTPreconditioner< TAlgebra >::m_spOrderingAlgo.
|
inlineprotectedvirtual |
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 from ug::IPreconditioner< TAlgebra >.
References ug::IPreconditioner< TAlgebra >::init(), SmartPtr< T, FreePolicy >::invalid(), ug::ILUTPreconditioner< TAlgebra >::m_u, ug::ILUTPreconditioner< TAlgebra >::name(), and UG_THROW.
|
inlineprotected |
|
inlineprotected |
|
inlinevirtual |
|
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
Implements ug::IPreconditioner< TAlgebra >.
Referenced by ug::ILUTPreconditioner< TAlgebra >::init().
|
inlinevirtual |
cleans the operator
Implements ug::IPreconditioner< TAlgebra >.
|
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::ILUTPreconditioner< TAlgebra >::preprocess_mat().
|
inlinevirtual |
|
inlinevirtual |
References ug::BlockMatrixFiniteAndNotTooBig(), ug::BlockNorm(), ug::GetInversePermutation(), ug::ILUTPreconditioner< TAlgebra >::m_bSortIsIdentity, ug::ILUTPreconditioner< TAlgebra >::m_eps, ug::ILUTPreconditioner< TAlgebra >::m_info, ug::ILUTPreconditioner< TAlgebra >::m_L, ug::ILUTPreconditioner< TAlgebra >::m_old_ordering, ug::ILUTPreconditioner< TAlgebra >::m_ordering, ug::ILUTPreconditioner< TAlgebra >::m_show_progress, ug::ILUTPreconditioner< TAlgebra >::m_spOrderingAlgo, ug::ILUTPreconditioner< TAlgebra >::m_U, ug::ILUTPreconditioner< TAlgebra >::m_u, PROFILE_BEGIN_GROUP, PROGRESS_FINISH, PROGRESS_START_WITH, PROGRESS_UPDATE, ug::reset_floats(), ug::SetMatrixAsPermutation(), STATIC_ASSERT, UG_COND_THROW, UG_LOG, and ug::DebugWritingObject< TAlgebra >::write_debug().
Referenced by ug::ILUTPreconditioner< TAlgebra >::preprocess_mat().
|
inline |
sets storage information output to true or false
References ug::ILUTPreconditioner< TAlgebra >::m_info.
Referenced by ug::ILUTPreconditioner< TAlgebra >::ILUTPreconditioner().
|
inline |
sets an ordering algorithm
References ug::ILUTPreconditioner< TAlgebra >::m_spOrderingAlgo.
|
inline |
set whether the progress meter should be shown
References ug::ILUTPreconditioner< TAlgebra >::m_show_progress, and s.
|
inline |
set cuthill-mckee sort on/off
References ug::ILUTPreconditioner< TAlgebra >::m_spOrderingAlgo, make_sp(), SPNULL, and UG_LOG.
|
inline |
sets threshold for incomplete LU factorisation (added 01122010ih)
References ug::ILUTPreconditioner< TAlgebra >::m_eps.
|
inlinevirtual |
References ug::ILUTPreconditioner< TAlgebra >::applyLU(), ug::ILUTPreconditioner< TAlgebra >::c2, ug::ILUTPreconditioner< TAlgebra >::m_bSortIsIdentity, ug::ILUTPreconditioner< TAlgebra >::m_old_ordering, ug::ILUTPreconditioner< TAlgebra >::m_ordering, ug::ILUTPreconditioner< TAlgebra >::m_spOrderingAlgo, PROFILE_BEGIN_GROUP, and ug::SetVectorAsPermutation().
Referenced by ug::ILUTPreconditioner< TAlgebra >::step().
|
inlinevirtual |
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::PST_ADDITIVE, ug::PST_CONSISTENT, ug::PST_UNIQUE, and ug::ILUTPreconditioner< TAlgebra >::solve().
|
inlinevirtual |
returns if parallel solving is supported
Implements ug::ILinearIterator< TAlgebra::vector_type >.
|
protected |
Referenced by ug::ILUTPreconditioner< TAlgebra >::solve().
|
protected |
|
protected |
Referenced by ug::ILUTPreconditioner< TAlgebra >::applyLU(), ug::ILUTPreconditioner< TAlgebra >::config_string(), ug::ILUTPreconditioner< TAlgebra >::ILUTPreconditioner(), ug::ILUTPreconditioner< TAlgebra >::multi_apply(), ug::ILUTPreconditioner< TAlgebra >::preprocess_mat2(), and ug::ILUTPreconditioner< TAlgebra >::set_threshold().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
protected |
for ordering algorithms
Referenced by ug::ILUTPreconditioner< TAlgebra >::config_string(), ug::ILUTPreconditioner< TAlgebra >::ILUTPreconditioner(), ug::ILUTPreconditioner< TAlgebra >::preprocess_mat2(), ug::ILUTPreconditioner< TAlgebra >::set_ordering_algorithm(), ug::ILUTPreconditioner< TAlgebra >::set_sort(), and ug::ILUTPreconditioner< TAlgebra >::solve().
|
protected |
|
protected |
|
protected |
|
protected |