Class xlifepp::PreconditionerTerm#

class PreconditionerTerm : public xlifepp::Preconditioner#

Inheritence diagram for xlifepp::PreconditionerTerm:

digraph { graph [bgcolor="#00000000"] node [shape=rectangle style=filled fillcolor="#FFFFFF" font=Helvetica padding=2] edge [color="#1414CE"] "2" [label="xlifepp::Preconditioner" tooltip="xlifepp::Preconditioner"] "1" [label="xlifepp::PreconditionerTerm" tooltip="xlifepp::PreconditionerTerm" fillcolor="#BFBFBF"] "1" -> "2" [dir=forward tooltip="public-inheritance"] }

Collaboration diagram for xlifepp::PreconditionerTerm:

digraph { graph [bgcolor="#00000000"] node [shape=rectangle style=filled fillcolor="#FFFFFF" font=Helvetica padding=2] edge [color="#1414CE"] "38" [label="xlifepp::LargeMatrix< complex_t >" tooltip="xlifepp::LargeMatrix< complex_t >"] "33" [label="xlifepp::LargeMatrix< real_t >" tooltip="xlifepp::LargeMatrix< real_t >"] "41" [label="xlifepp::LargeMatrix< xlifepp::Matrix< complex_t > >" tooltip="xlifepp::LargeMatrix< xlifepp::Matrix< complex_t > >"] "39" [label="xlifepp::LargeMatrix< xlifepp::Matrix< real_t > >" tooltip="xlifepp::LargeMatrix< xlifepp::Matrix< real_t > >"] "21" [label="xlifepp::Vector< complex_t >" tooltip="xlifepp::Vector< complex_t >"] "17" [label="xlifepp::Vector< real_t >" tooltip="xlifepp::Vector< real_t >"] "25" [label="xlifepp::Vector< xlifepp::Vector< complex_t > >" tooltip="xlifepp::Vector< xlifepp::Vector< complex_t > >"] "23" [label="xlifepp::Vector< xlifepp::Vector< real_t > >" tooltip="xlifepp::Vector< xlifepp::Vector< real_t > >"] "44" [label="std::map< const Unknown *, Constraints * >" tooltip="std::map< const Unknown *, Constraints * >"] "14" [label="std::map< const xlifepp::Unknown *, xlifepp::SuLinearForm >" tooltip="std::map< const xlifepp::Unknown *, xlifepp::SuLinearForm >"] "15" [label="std::map< const xlifepp::Unknown *, xlifepp::SuTermVector * >" tooltip="std::map< const xlifepp::Unknown *, xlifepp::SuTermVector * >"] "10" [label="std::map< string_t, number_t >" tooltip="std::map< string_t, number_t >"] "30" [label="std::map< uvPair, xlifepp::SuBilinearForm >" tooltip="std::map< uvPair, xlifepp::SuBilinearForm >"] "31" [label="std::map< uvPair, xlifepp::SuTermMatrix * >" tooltip="std::map< uvPair, xlifepp::SuTermMatrix * >"] "45" [label="std::set< xlifepp::Unknown * >" tooltip="std::set< xlifepp::Unknown * >"] "11" [label="std::map< K, T >" tooltip="std::map< K, T >"] "46" [label="std::set< K >" tooltip="std::set< K >"] "9" [label="std::vector< T >" tooltip="std::vector< T >"] "20" [label="std::vector< K >" tooltip="std::vector< K >"] "22" [label="std::vector< complex_t >" tooltip="std::vector< complex_t >"] "34" [label="std::vector< number_t >" tooltip="std::vector< number_t >"] "18" [label="std::vector< real_t >" tooltip="std::vector< real_t >"] "27" [label="std::vector< xlifepp::DofComponent >" tooltip="std::vector< xlifepp::DofComponent >"] "42" [label="std::vector< xlifepp::Matrix< complex_t > >" tooltip="std::vector< xlifepp::Matrix< complex_t > >"] "40" [label="std::vector< xlifepp::Matrix< real_t > >" tooltip="std::vector< xlifepp::Matrix< real_t > >"] "36" [label="std::vector< xlifepp::MatrixStorage * >" tooltip="std::vector< xlifepp::MatrixStorage * >"] "8" [label="std::vector< xlifepp::Parameter * >" tooltip="std::vector< xlifepp::Parameter * >"] "12" [label="std::vector< xlifepp::Term * >" tooltip="std::vector< xlifepp::Term * >"] "26" [label="std::vector< xlifepp::Vector< complex_t > >" tooltip="std::vector< xlifepp::Vector< complex_t > >"] "24" [label="std::vector< xlifepp::Vector< real_t > >" tooltip="std::vector< xlifepp::Vector< real_t > >"] "29" [label="xlifepp::BilinearForm" tooltip="xlifepp::BilinearForm"] "5" [label="xlifepp::ComputingInfo" tooltip="xlifepp::ComputingInfo"] "37" [label="xlifepp::LargeMatrix< T >" tooltip="xlifepp::LargeMatrix< T >"] "13" [label="xlifepp::LinearForm" tooltip="xlifepp::LinearForm"] "32" [label="xlifepp::MatrixEntry" tooltip="xlifepp::MatrixEntry"] "35" [label="xlifepp::MatrixStorage" tooltip="xlifepp::MatrixStorage"] "7" [label="xlifepp::Parameters" tooltip="xlifepp::Parameters"] "2" [label="xlifepp::Preconditioner" tooltip="xlifepp::Preconditioner"] "1" [label="xlifepp::PreconditionerTerm" tooltip="xlifepp::PreconditionerTerm" fillcolor="#BFBFBF"] "6" [label="xlifepp::ReductionMethod" tooltip="xlifepp::ReductionMethod"] "43" [label="xlifepp::SetOfConstraints" tooltip="xlifepp::SetOfConstraints"] "4" [label="xlifepp::Term" tooltip="xlifepp::Term"] "28" [label="xlifepp::TermMatrix" tooltip="xlifepp::TermMatrix"] "3" [label="xlifepp::TermVector" tooltip="xlifepp::TermVector"] "19" [label="xlifepp::Vector< K >" tooltip="xlifepp::Vector< K >"] "16" [label="xlifepp::VectorEntry" tooltip="xlifepp::VectorEntry"] "38" -> "34" [dir=forward tooltip="usage"] "38" -> "35" [dir=forward tooltip="usage"] "38" -> "37" [dir=forward tooltip="template-instance"] "33" -> "34" [dir=forward tooltip="usage"] "33" -> "18" [dir=forward tooltip="usage"] "33" -> "35" [dir=forward tooltip="usage"] "33" -> "37" [dir=forward tooltip="template-instance"] "41" -> "34" [dir=forward tooltip="usage"] "41" -> "42" [dir=forward tooltip="usage"] "41" -> "35" [dir=forward tooltip="usage"] "41" -> "37" [dir=forward tooltip="template-instance"] "39" -> "34" [dir=forward tooltip="usage"] "39" -> "40" [dir=forward tooltip="usage"] "39" -> "35" [dir=forward tooltip="usage"] "39" -> "37" [dir=forward tooltip="template-instance"] "21" -> "22" [dir=forward tooltip="public-inheritance"] "21" -> "19" [dir=forward tooltip="template-instance"] "17" -> "18" [dir=forward tooltip="public-inheritance"] "17" -> "19" [dir=forward tooltip="template-instance"] "25" -> "26" [dir=forward tooltip="public-inheritance"] "25" -> "19" [dir=forward tooltip="template-instance"] "23" -> "24" [dir=forward tooltip="public-inheritance"] "23" -> "19" [dir=forward tooltip="template-instance"] "44" -> "11" [dir=forward tooltip="template-instance"] "14" -> "11" [dir=forward tooltip="template-instance"] "15" -> "11" [dir=forward tooltip="template-instance"] "10" -> "11" [dir=forward tooltip="template-instance"] "30" -> "11" [dir=forward tooltip="template-instance"] "31" -> "11" [dir=forward tooltip="template-instance"] "45" -> "46" [dir=forward tooltip="template-instance"] "20" -> "9" [dir=forward tooltip="template-instance"] "22" -> "9" [dir=forward tooltip="template-instance"] "34" -> "9" [dir=forward tooltip="template-instance"] "18" -> "9" [dir=forward tooltip="template-instance"] "27" -> "9" [dir=forward tooltip="template-instance"] "42" -> "9" [dir=forward tooltip="template-instance"] "40" -> "9" [dir=forward tooltip="template-instance"] "36" -> "9" [dir=forward tooltip="template-instance"] "8" -> "9" [dir=forward tooltip="template-instance"] "12" -> "9" [dir=forward tooltip="template-instance"] "26" -> "9" [dir=forward tooltip="template-instance"] "24" -> "9" [dir=forward tooltip="template-instance"] "29" -> "30" [dir=forward tooltip="usage"] "5" -> "6" [dir=forward tooltip="usage"] "37" -> "34" [dir=forward tooltip="usage"] "37" -> "35" [dir=forward tooltip="usage"] "13" -> "14" [dir=forward tooltip="usage"] "32" -> "33" [dir=forward tooltip="usage"] "32" -> "38" [dir=forward tooltip="usage"] "32" -> "39" [dir=forward tooltip="usage"] "32" -> "41" [dir=forward tooltip="usage"] "35" -> "36" [dir=forward tooltip="usage"] "7" -> "8" [dir=forward tooltip="usage"] "7" -> "10" [dir=forward tooltip="usage"] "2" -> "3" [dir=forward tooltip="usage"] "1" -> "2" [dir=forward tooltip="public-inheritance"] "1" -> "28" [dir=forward tooltip="usage"] "43" -> "44" [dir=forward tooltip="public-inheritance"] "43" -> "45" [dir=forward tooltip="usage"] "4" -> "5" [dir=forward tooltip="usage"] "4" -> "7" [dir=forward tooltip="usage"] "4" -> "12" [dir=forward tooltip="usage"] "28" -> "4" [dir=forward tooltip="public-inheritance"] "28" -> "29" [dir=forward tooltip="usage"] "28" -> "31" [dir=forward tooltip="usage"] "28" -> "32" [dir=forward tooltip="usage"] "28" -> "43" [dir=forward tooltip="usage"] "28" -> "27" [dir=forward tooltip="usage"] "3" -> "4" [dir=forward tooltip="public-inheritance"] "3" -> "13" [dir=forward tooltip="usage"] "3" -> "15" [dir=forward tooltip="usage"] "3" -> "16" [dir=forward tooltip="usage"] "3" -> "27" [dir=forward tooltip="usage"] "19" -> "20" [dir=forward tooltip="public-inheritance"] "16" -> "17" [dir=forward tooltip="usage"] "16" -> "21" [dir=forward tooltip="usage"] "16" -> "23" [dir=forward tooltip="usage"] "16" -> "25" [dir=forward tooltip="usage"] }

Define the preconditioner for linear systems.

This is a main class that users can derive to deal with preconditioning by operators. In most of the cases, users will use xlifepp::PreconditionerTerm when it is a preconditioning with TermMatrix/TermVector level (or MatrixEntry/VectorEntry)

Public Functions

inline PreconditionerTerm()#

default constructor

inline PreconditionerTerm(const PreconditionerTerm &pt)#

copy constructor

PreconditionerTerm(TermMatrix &A, PreconditionerType pt = _productPrec, const real_t w = 1.)#

constructor from matrix

~PreconditionerTerm()#

destructor

TermVector leftSolve(TermVector &B) const#

Transpose Solver with B.

LeftSolver with B.

virtual void leftSolve(TermVector &B, TermVector &X) const#

Transpose Solver with B and X.

inline void print() const#

print utility (const)

inline void print(std::ostream &os) const#

< print utility

TermVector solve(TermVector &B) const#

Solver with B.

virtual void solve(TermVector &B, TermVector &X) const#

Solver with B and X.

virtual ValueType valueType() const#

returns ValueType of preconditionner

test if Preconditioner is empty or not

Public Members

TermMatrix *precondMatrix_p#

precondition matrix