PARALUTION  1.0.0
PARALUTION
Public Member Functions | Protected Member Functions | Protected Attributes
paralution::MultiColored< OperatorType, VectorType, ValueType > Class Template Referenceabstract

#include <preconditioner_multicolored.hpp>

Inheritance diagram for paralution::MultiColored< OperatorType, VectorType, ValueType >:
paralution::Preconditioner< OperatorType, VectorType, ValueType > paralution::Solver< OperatorType, VectorType, ValueType > paralution::ParalutionObj paralution::MultiColoredILU< OperatorType, VectorType, ValueType > paralution::MultiColoredSGS< OperatorType, VectorType, ValueType > paralution::MultiColoredGS< OperatorType, VectorType, ValueType >

Public Member Functions

 MultiColored ()
 
virtual ~MultiColored ()
 
virtual void Clear (void)
 Clear (free all local data) the solver. More...
 
virtual void Build (void)
 Build the solver (data allocation, structure computation, numerical computation) More...
 
virtual void SetPrecondMatrixFormat (const unsigned int mat_format)
 Set a specific matrix type of the decomposed block matrices; if not set, CSR matrix format will be used. More...
 
virtual void SetDecomposition (const bool decomp)
 Set if the preconditioner should be decomposed or not. More...
 
virtual void Solve (const VectorType &rhs, VectorType *x)
 Solve Operator x = rhs. More...
 
virtual void SolveZeroSol (const VectorType &rhs, VectorType *x)
 Solve Operator x = rhs; but set first the init x = 0. More...
 
void SetOperator (const OperatorType &op)
 Set the Operator of the solver. More...
 
virtual void ResetOperator (const OperatorType &op)
 Reset the operator; see ReBuildNumeric. More...
 
virtual void Print (void) const =0
 Print information about the solver. More...
 
virtual void ReBuildNumeric (void)
 Rebuild only with numerical computation (no allocation or data structure computation) More...
 
virtual void MoveToHost (void)
 Move all the data (i.e. move the solver) to the host. More...
 
virtual void MoveToAccelerator (void)
 Move all the data (i.e. move the solver) to the accelerator. More...
 
virtual void Verbose (const int verb=1)
 Provide verbose output of the solver: verb == 0 no output verb == 1 print info about the solver (start,end); verb == 2 print (iter, residual) via iteration control;. More...
 

Protected Member Functions

virtual void ExtractRHSinX_ (const VectorType &rhs, VectorType *x)
 Extract the rhs into x under the permutation (see Analyse_()) and decompose x into block (x_block_[]) More...
 
virtual void SolveL_ (void)=0
 Solve the lower-triangular (left) matrix. More...
 
virtual void SolveD_ (void)=0
 Solve the diagonal part (only for SGS) More...
 
virtual void SolveR_ (void)=0
 Solve the upper-trianguler (right) matrix. More...
 
virtual void Solve_ (const VectorType &rhs, VectorType *x)=0
 Solve directly without block decomposition. More...
 
virtual void InsertSolution_ (VectorType *x)
 Insert the solution with backward permutation (from x_block_[]) More...
 
virtual void Build_Analyser_ (void)
 Build the analyzing matrix. More...
 
virtual void Analyse_ (void)
 Analyse the matrix (i.e. multi-coloring decomposition) More...
 
virtual void Permute_ (void)
 Permute the preconditioning matrix. More...
 
virtual void Factorize_ (void)
 Factorize (i.e. build the preconditioner) More...
 
virtual void Decompose_ (void)
 Decompose the structure into blocks (preconditioner_block_[] for the preconditioning matrix; and x_block_[] for the x vector) More...
 
virtual void PostAnalyse_ (void)
 Post-analyzing if the preconditioner is not decomposed. More...
 
virtual void MoveToHostLocalData_ (void)
 Move all local data to the host. More...
 
virtual void MoveToAcceleratorLocalData_ (void)
 Move all local data to the accelerator. More...
 
virtual void PrintStart_ (void) const
 Print starting msg of the solver. More...
 
virtual void PrintEnd_ (void) const
 Print ending msg of the solver. More...
 

Protected Attributes

OperatorType * analyzer_op_
 
OperatorType * preconditioner_
 
OperatorType *** preconditioner_block_
 
VectorType ** x_block_
 
VectorType ** diag_block_
 
VectorType x_
 
VectorType diag_
 
Solver< OperatorType, VectorType, ValueType > ** diag_solver_
 
int num_blocks_
 
int * block_sizes_
 
bool op_mat_format_
 Keep the precond matrix in CSR or not. More...
 
unsigned int precond_mat_format_
 Precond matrix format. More...
 
bool decomp_
 Decompose the preconditioner into blocks or not. More...
 
const OperatorType * op_
 Pointer to the operator. More...
 
Solver< OperatorType, VectorType, ValueType > * precond_
 Pointer to the defined preconditioner. More...
 
bool build_
 Flag == true after building the solver (e.g. Build()) More...
 
LocalVector< int > permutation_
 Permutation vector (used if the solver performs permutation/re-ordering techniques) More...
 
int verb_
 Verbose flag verb == 0 no output verb == 1 print info about the solver (start,end); verb == 2 print (iter, residual) via iteration control;. More...
 
size_t global_obj_id
 

Constructor & Destructor Documentation

template<class OperatorType , class VectorType , typename ValueType >
paralution::MultiColored< OperatorType, VectorType, ValueType >::MultiColored ( )
template<class OperatorType , class VectorType , typename ValueType >
paralution::MultiColored< OperatorType, VectorType, ValueType >::~MultiColored ( )
virtual

Member Function Documentation

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Analyse_ ( void  )
protectedvirtual

Analyse the matrix (i.e. multi-coloring decomposition)

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Build ( void  )
virtual

Build the solver (data allocation, structure computation, numerical computation)

Reimplemented from paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Build_Analyser_ ( void  )
protectedvirtual

Build the analyzing matrix.

Reimplemented in paralution::MultiColoredILU< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Clear ( void  )
virtual

Clear (free all local data) the solver.

Reimplemented from paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Decompose_ ( void  )
protectedvirtual

Decompose the structure into blocks (preconditioner_block_[] for the preconditioning matrix; and x_block_[] for the x vector)

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::ExtractRHSinX_ ( const VectorType &  rhs,
VectorType *  x 
)
protectedvirtual

Extract the rhs into x under the permutation (see Analyse_()) and decompose x into block (x_block_[])

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Factorize_ ( void  )
protectedvirtual

Factorize (i.e. build the preconditioner)

Reimplemented in paralution::MultiColoredILU< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::InsertSolution_ ( VectorType *  x)
protectedvirtual

Insert the solution with backward permutation (from x_block_[])

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::MoveToAccelerator ( void  )
virtualinherited

Move all the data (i.e. move the solver) to the accelerator.

Referenced by main(), mexFunction(), and paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::MoveToAcceleratorLocalData_ ( void  )
protectedvirtual

Move all local data to the accelerator.

Implements paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::MoveToHost ( void  )
virtualinherited

Move all the data (i.e. move the solver) to the host.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::MoveToHostLocalData_ ( void  )
protectedvirtual

Move all local data to the host.

Implements paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Permute_ ( void  )
protectedvirtual

Permute the preconditioning matrix.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::PostAnalyse_ ( void  )
protectedvirtual

Post-analyzing if the preconditioner is not decomposed.

Reimplemented in paralution::MultiColoredGS< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, and paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >.

template<class OperatorType, class VectorType, typename ValueType>
virtual void paralution::Solver< OperatorType, VectorType, ValueType >::Print ( void  ) const
pure virtualinherited

Print information about the solver.

Implemented in paralution::IC< OperatorType, VectorType, ValueType >, paralution::FixedPoint< OperatorType, VectorType, ValueType >, paralution::ILUT< OperatorType, VectorType, ValueType >, paralution::TNS< OperatorType, VectorType, ValueType >, paralution::ILU< OperatorType, VectorType, ValueType >, paralution::SGS< OperatorType, VectorType, ValueType >, paralution::SPAI< OperatorType, VectorType, ValueType >, paralution::GS< OperatorType, VectorType, ValueType >, paralution::RAS< OperatorType, VectorType, ValueType >, paralution::FSAI< OperatorType, VectorType, ValueType >, paralution::FSAI< paralution::LocalMatrix< ValueTypeL >, paralution::LocalVector< ValueTypeL >, ValueTypeL >, paralution::FSAI< paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueTypeH >, ValueTypeH >, paralution::MultiColoredGS< OperatorType, VectorType, ValueType >, paralution::SIRA< OperatorTypeH, VectorTypeH, ValueTypeH, OperatorTypeL, VectorTypeL, ValueTypeL >, paralution::CG_HN< OperatorType, VectorType, ValueType >, paralution::CG_HN< OperatorTypeL, VectorTypeL, ValueTypeL >, paralution::CG_HN< OperatorTypeH, VectorTypeH, ValueTypeH >, paralution::DPCG< OperatorType, VectorType, ValueType >, paralution::Jacobi< OperatorType, VectorType, ValueType >, paralution::MultiElimination< OperatorType, VectorType, ValueType >, paralution::AMG< OperatorType, VectorType, ValueType >, paralution::BaseMultiGrid< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, paralution::IDR< OperatorType, VectorType, ValueType >, paralution::AIChebyshev< OperatorType, VectorType, ValueType >, paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >, paralution::BlockPreconditioner< OperatorType, VectorType, ValueType >, paralution::DiagJacobiSaddlePointPrecond< OperatorType, VectorType, ValueType >, paralution::Chebyshev< OperatorType, VectorType, ValueType >, paralution::BiCGStab< OperatorType, VectorType, ValueType >, paralution::CG< OperatorType, VectorType, ValueType >, paralution::CR< OperatorType, VectorType, ValueType >, paralution::FGMRES< OperatorType, VectorType, ValueType >, paralution::GMRES< OperatorType, VectorType, ValueType >, paralution::CG< OperatorTypeL, VectorTypeL, ValueTypeL >, paralution::CG< OperatorTypeH, VectorTypeH, ValueTypeH >, paralution::MixedPrecisionDC< OperatorTypeH, VectorTypeH, ValueTypeH, OperatorTypeL, VectorTypeL, ValueTypeL >, paralution::AS< OperatorType, VectorType, ValueType >, paralution::Inversion< OperatorType, VectorType, ValueType >, paralution::LU< OperatorType, VectorType, ValueType >, and paralution::QR< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Preconditioner< OperatorType, VectorType, ValueType >::PrintEnd_ ( void  ) const
protectedvirtualinherited

Print ending msg of the solver.

Implements paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Preconditioner< OperatorType, VectorType, ValueType >::PrintStart_ ( void  ) const
protectedvirtualinherited

Print starting msg of the solver.

Implements paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::ReBuildNumeric ( void  )
virtualinherited

Rebuild only with numerical computation (no allocation or data structure computation)

Reimplemented in paralution::FixedPoint< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, and paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >.

template<class OperatorType, class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::ResetOperator ( const OperatorType &  op)
virtualinherited

Reset the operator; see ReBuildNumeric.

Reimplemented in paralution::SGS< OperatorType, VectorType, ValueType >, paralution::GS< OperatorType, VectorType, ValueType >, and paralution::Jacobi< OperatorType, VectorType, ValueType >.

Referenced by main().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::SetDecomposition ( const bool  decomp)
virtual

Set if the preconditioner should be decomposed or not.

template<class OperatorType, class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::SetOperator ( const OperatorType &  op)
inherited

Set the Operator of the solver.

Referenced by paralution::BaseAMG< OperatorType, VectorType, ValueType >::Build(), paralution::MultiElimination< OperatorType, VectorType, ValueType >::Build(), paralution::MultiColored< OperatorType, VectorType, ValueType >::Decompose_(), main(), mexFunction(), paralution_fortran_solve(), and paralution_solve().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::SetPrecondMatrixFormat ( const unsigned int  mat_format)
virtual

Set a specific matrix type of the decomposed block matrices; if not set, CSR matrix format will be used.

Referenced by paralution::AMG< OperatorType, VectorType, ValueType >::BuildSmoothers(), main(), and paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::MultiColored< OperatorType, VectorType, ValueType >::Solve ( const VectorType &  rhs,
VectorType *  x 
)
virtual

Solve Operator x = rhs.

Implements paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType, class VectorType, typename ValueType>
virtual void paralution::MultiColored< OperatorType, VectorType, ValueType >::Solve_ ( const VectorType &  rhs,
VectorType *  x 
)
protectedpure virtual

Solve directly without block decomposition.

Implemented in paralution::MultiColoredGS< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, and paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >.

template<class OperatorType, class VectorType, typename ValueType>
virtual void paralution::MultiColored< OperatorType, VectorType, ValueType >::SolveD_ ( void  )
protectedpure virtual

Solve the diagonal part (only for SGS)

Implemented in paralution::MultiColoredGS< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, and paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >.

template<class OperatorType, class VectorType, typename ValueType>
virtual void paralution::MultiColored< OperatorType, VectorType, ValueType >::SolveL_ ( void  )
protectedpure virtual

Solve the lower-triangular (left) matrix.

Implemented in paralution::MultiColoredGS< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, and paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >.

template<class OperatorType, class VectorType, typename ValueType>
virtual void paralution::MultiColored< OperatorType, VectorType, ValueType >::SolveR_ ( void  )
protectedpure virtual

Solve the upper-trianguler (right) matrix.

Implemented in paralution::MultiColoredGS< OperatorType, VectorType, ValueType >, paralution::MultiColoredILU< OperatorType, VectorType, ValueType >, and paralution::MultiColoredSGS< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType, typename ValueType >
void paralution::Preconditioner< OperatorType, VectorType, ValueType >::SolveZeroSol ( const VectorType &  rhs,
VectorType *  x 
)
virtualinherited

Solve Operator x = rhs; but set first the init x = 0.

Reimplemented from paralution::Solver< OperatorType, VectorType, ValueType >.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::Verbose ( const int  verb = 1)
virtualinherited

Provide verbose output of the solver: verb == 0 no output verb == 1 print info about the solver (start,end); verb == 2 print (iter, residual) via iteration control;.

Reimplemented in paralution::DirectLinearSolver< OperatorType, VectorType, ValueType >, paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >, paralution::IterativeLinearSolver< OperatorTypeL, VectorTypeL, ValueTypeL >, paralution::IterativeLinearSolver< OperatorTypeH, VectorTypeH, ValueTypeH >, and paralution::SIRA< OperatorTypeH, VectorTypeH, ValueTypeH, OperatorTypeL, VectorTypeL, ValueTypeL >.

Field Documentation

template<class OperatorType, class VectorType, typename ValueType>
OperatorType* paralution::MultiColored< OperatorType, VectorType, ValueType >::analyzer_op_
protected
template<class OperatorType, class VectorType, typename ValueType>
int* paralution::MultiColored< OperatorType, VectorType, ValueType >::block_sizes_
protected
template<class OperatorType, class VectorType, typename ValueType>
bool paralution::Solver< OperatorType, VectorType, ValueType >::build_
protectedinherited

Flag == true after building the solver (e.g. Build())

template<class OperatorType, class VectorType, typename ValueType>
bool paralution::MultiColored< OperatorType, VectorType, ValueType >::decomp_
protected

Decompose the preconditioner into blocks or not.

template<class OperatorType, class VectorType, typename ValueType>
VectorType paralution::MultiColored< OperatorType, VectorType, ValueType >::diag_
protected
template<class OperatorType, class VectorType, typename ValueType>
VectorType** paralution::MultiColored< OperatorType, VectorType, ValueType >::diag_block_
protected
template<class OperatorType, class VectorType, typename ValueType>
Solver<OperatorType, VectorType, ValueType>** paralution::MultiColored< OperatorType, VectorType, ValueType >::diag_solver_
protected
size_t paralution::ParalutionObj::global_obj_id
protectedinherited

Referenced by paralution::ParalutionObj::ParalutionObj(), and paralution::ParalutionObj::~ParalutionObj().

template<class OperatorType, class VectorType, typename ValueType>
int paralution::MultiColored< OperatorType, VectorType, ValueType >::num_blocks_
protected
template<class OperatorType, class VectorType, typename ValueType>
const OperatorType* paralution::Solver< OperatorType, VectorType, ValueType >::op_
protectedinherited

Pointer to the operator.

template<class OperatorType, class VectorType, typename ValueType>
bool paralution::MultiColored< OperatorType, VectorType, ValueType >::op_mat_format_
protected

Keep the precond matrix in CSR or not.

template<class OperatorType, class VectorType, typename ValueType>
LocalVector<int> paralution::Solver< OperatorType, VectorType, ValueType >::permutation_
protectedinherited

Permutation vector (used if the solver performs permutation/re-ordering techniques)

template<class OperatorType, class VectorType, typename ValueType>
Solver<OperatorType, VectorType, ValueType>* paralution::Solver< OperatorType, VectorType, ValueType >::precond_
protectedinherited

Pointer to the defined preconditioner.

template<class OperatorType, class VectorType, typename ValueType>
unsigned int paralution::MultiColored< OperatorType, VectorType, ValueType >::precond_mat_format_
protected

Precond matrix format.

template<class OperatorType, class VectorType, typename ValueType>
OperatorType* paralution::MultiColored< OperatorType, VectorType, ValueType >::preconditioner_
protected
template<class OperatorType, class VectorType, typename ValueType>
OperatorType*** paralution::MultiColored< OperatorType, VectorType, ValueType >::preconditioner_block_
protected
template<class OperatorType, class VectorType, typename ValueType>
int paralution::Solver< OperatorType, VectorType, ValueType >::verb_
protectedinherited

Verbose flag verb == 0 no output verb == 1 print info about the solver (start,end); verb == 2 print (iter, residual) via iteration control;.

template<class OperatorType, class VectorType, typename ValueType>
VectorType paralution::MultiColored< OperatorType, VectorType, ValueType >::x_
protected
template<class OperatorType, class VectorType, typename ValueType>
VectorType** paralution::MultiColored< OperatorType, VectorType, ValueType >::x_block_
protected
The documentation for this class was generated from the following files: