ug4
|
#include <line_smoothers.h>
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_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 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 () |
LineGaussSeidel (SmartPtr< ApproximationSpace< TDomain > > approxSpace) | |
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) |
virtual bool | supports_parallel () const |
returns if parallel solving is supported More... | |
bool | update (size_t xsize) |
~LineGaussSeidel () | |
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 | linegs_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... | |
Static Protected Attributes | |
static const int | dim = domain_type::dim |
world dimension More... | |
typedef TAlgebra ug::LineGaussSeidel< TDomain, TAlgebra >::algebra_type |
typedef IPreconditioner<TAlgebra> ug::LineGaussSeidel< TDomain, TAlgebra >::base_type |
Base type.
typedef TDomain ug::LineGaussSeidel< TDomain, TAlgebra >::domain_type |
typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::LineGaussSeidel< TDomain, TAlgebra >::matrix_operator_type |
Matrix Operator type.
typedef TAlgebra::matrix_type ug::LineGaussSeidel< TDomain, TAlgebra >::matrix_type |
typedef TAlgebra::vector_type ug::LineGaussSeidel< TDomain, TAlgebra >::vector_type |
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_init, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz, and ug::LineGaussSeidel< TDomain, TAlgebra >::m_spApproxSpace.
|
inline |
|
inlinevirtual |
clone
Implements ug::ILinearIterator< TAlgebra::vector_type >.
References ug::ILinearIterator< TAlgebra::vector_type >::damping(), ug::DebugWritingObject< TAlgebra >::debug_writer(), ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_backwardx(), ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_backwardy(), ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_backwardz(), ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_forwardx(), ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_forwardy(), ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_forwardz(), and ug::LineGaussSeidel< TDomain, TAlgebra >::m_spApproxSpace.
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::clone().
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::clone().
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::clone().
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::clone().
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::clone().
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::clone().
|
inlineprotected |
References ug::LineGaussSeidel< TDomain, TAlgebra >::dim, ug::LineGaussSeidel< TDomain, TAlgebra >::indY, ug::LineGaussSeidel< TDomain, TAlgebra >::indZ, ug::InverseMatMult(), ug::LineGaussSeidel< TDomain, TAlgebra >::m_ind_end, ug::LineGaussSeidel< TDomain, TAlgebra >::m_init, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz, ug::MatMultAdd(), s, and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::step().
|
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 >.
|
inlineprotectedvirtual |
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 pcl::CollectUniqueElements(), ug::LineGaussSeidel< TDomain, TAlgebra >::m_A, ug::MakeConsistent(), pcl::NumProcs(), and ug::SetDirichletRow().
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy, and ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz.
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy, and ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz.
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy, and ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz.
|
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::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::m_A, pcl::NumProcs(), and ug::PST_UNIQUE.
|
inlinevirtual |
returns if parallel solving is supported
Implements ug::ILinearIterator< TAlgebra::vector_type >.
|
inline |
References ug::LineGaussSeidel< TDomain, TAlgebra >::dim, ug::LineGaussSeidel< TDomain, TAlgebra >::indY, ug::LineGaussSeidel< TDomain, TAlgebra >::indZ, ug::GridLevel::LEVEL, ug::LineGaussSeidel< TDomain, TAlgebra >::m_ind_end, ug::LineGaussSeidel< TDomain, TAlgebra >::m_init, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_backwardz, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardx, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardy, ug::LineGaussSeidel< TDomain, TAlgebra >::m_nr_forwardz, and ug::LineGaussSeidel< TDomain, TAlgebra >::m_spApproxSpace.
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step().
|
staticprotected |
world dimension
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_backwardx(), ug::LineGaussSeidel< TDomain, TAlgebra >::LineGaussSeidel(), ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::set_num_steps(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_backwardy(), ug::LineGaussSeidel< TDomain, TAlgebra >::LineGaussSeidel(), ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::set_num_steps(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_backwardz(), ug::LineGaussSeidel< TDomain, TAlgebra >::LineGaussSeidel(), ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::set_num_steps(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_forwardx(), ug::LineGaussSeidel< TDomain, TAlgebra >::LineGaussSeidel(), ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::set_num_steps(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_forwardy(), ug::LineGaussSeidel< TDomain, TAlgebra >::LineGaussSeidel(), ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::set_num_steps(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |
Referenced by ug::LineGaussSeidel< TDomain, TAlgebra >::get_num_forwardz(), ug::LineGaussSeidel< TDomain, TAlgebra >::LineGaussSeidel(), ug::LineGaussSeidel< TDomain, TAlgebra >::linegs_step(), ug::LineGaussSeidel< TDomain, TAlgebra >::set_num_steps(), and ug::LineGaussSeidel< TDomain, TAlgebra >::update().
|
protected |