PARALUTION  1.0.0
PARALUTION
paralution::Chebyshev< OperatorType, VectorType, ValueType > Class Template Reference

#include <chebyshev.hpp>

Inheritance diagram for paralution::Chebyshev< OperatorType, VectorType, ValueType >:
paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType > paralution::Solver< OperatorType, VectorType, ValueType > paralution::ParalutionObj

Public Member Functions

 Chebyshev ()
 
virtual ~Chebyshev ()
 
virtual void Print (void) const
 Print information about the solver. More...
 
void Set (const ValueType lambda_min, const ValueType lambda_max)
 
virtual void Build (void)
 Build the solver (data allocation, structure computation, numerical computation) More...
 
virtual void Clear (void)
 Clear (free all local data) the solver. More...
 
void Init (const double abs_tol, const double rel_tol, const double div_tol, const int max_iter)
 Initialize the solver with absolute/relative/divergence tolerance and maximum number of iterations. More...
 
void Init (const double abs_tol, const double rel_tol, const double div_tol, const int min_iter, const int max_iter)
 Initialize the solver with absolute/relative/divergence tolerance and minimum/maximum number of iterations. More...
 
void InitMinIter (const int min_iter)
 Set the minimum number of iterations. More...
 
void InitMaxIter (const int max_iter)
 Set the maximum number of iterations. More...
 
void InitTol (const double abs, const double rel, const double div)
 Set the absolute/relative/divergence tolerance. More...
 
void SetResidualNorm (const int resnorm)
 Set the residual norm to L1, L2 or Inf norm resnorm == 1 L1 Norm resnorm == 2 L2 Norm (default) resnorm == 3 Inf Norm. More...
 
void RecordResidualHistory (void)
 Record the residual history. More...
 
void RecordHistory (const std::string filename) const
 Write the history to file. 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...
 
virtual void Solve (const VectorType &rhs, VectorType *x)
 Solve Operator x = rhs. More...
 
virtual void SetPreconditioner (Solver< OperatorType, VectorType, ValueType > &precond)
 Set a preconditioner of the linear solver. More...
 
virtual int GetIterationCount (void)
 Return the iteration count. More...
 
virtual double GetCurrentResidual (void)
 Return the current residual. More...
 
virtual int GetSolverStatus (void)
 Return the current status. More...
 
virtual int GetAmaxResidualIndex (void)
 Return absolute maximum index of residual vector when using Linf norm. 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 SolveZeroSol (const VectorType &rhs, VectorType *x)
 Solve Operator x = rhs; but set first the init x = 0. 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...
 

Protected Member Functions

virtual void SolveNonPrecond_ (const VectorType &rhs, VectorType *x)
 Non-preconditioner solution procedure. More...
 
virtual void SolvePrecond_ (const VectorType &rhs, VectorType *x)
 Preconditioned solution procedure. 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...
 
virtual void MoveToHostLocalData_ (void)
 Move all local data to the host. More...
 
virtual void MoveToAcceleratorLocalData_ (void)
 Move all local data to the accelerator. More...
 
ValueType Norm (const VectorType &vec)
 Computes the vector norm. More...
 

Protected Attributes

IterationControl iter_ctrl_
 Iteration control (monitor) More...
 
int res_norm_
 Residual norm res_norm = 1 L1 Norm res_norm = 2 L2 Norm res_norm = 3 Linf Norm. More...
 
int index_
 Absolute maximum index of residual vector when using Linf norm. 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< intpermutation_
 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
 

Private Attributes

bool init_lambda_
 
ValueType lambda_min_
 
ValueType lambda_max_
 
VectorType r_
 
VectorType z_
 
VectorType p_
 

Constructor & Destructor Documentation

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

Member Function Documentation

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

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

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

Referenced by main().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::Chebyshev< 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 >
int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetAmaxResidualIndex ( void  )
virtualinherited

Return absolute maximum index of residual vector when using Linf norm.

template<class OperatorType , class VectorType , typename ValueType >
double paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetCurrentResidual ( void  )
virtualinherited

Return the current residual.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >
int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetIterationCount ( void  )
virtualinherited

Return the iteration count.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >
int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetSolverStatus ( void  )
virtualinherited

Return the current status.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Init ( const double  abs_tol,
const double  rel_tol,
const double  div_tol,
const int  max_iter 
)
inherited

Initialize the solver with absolute/relative/divergence tolerance and maximum number of iterations.

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

template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Init ( const double  abs_tol,
const double  rel_tol,
const double  div_tol,
const int  min_iter,
const int  max_iter 
)
inherited

Initialize the solver with absolute/relative/divergence tolerance and minimum/maximum number of iterations.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::InitMaxIter ( const int  max_iter)
inherited

Set the maximum number of iterations.

Referenced by main().

template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::InitMinIter ( const int  min_iter)
inherited

Set the minimum number of iterations.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::InitTol ( const double  abs,
const double  rel,
const double  div 
)
inherited

Set the absolute/relative/divergence tolerance.

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::Chebyshev< 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::Chebyshev< 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 >
ValueType paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Norm ( const VectorType &  vec)
protectedinherited

Computes the vector norm.

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

Print information about the solver.

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

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

Print ending msg of the solver.

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

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

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
template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::RecordHistory ( const std::string  filename) const
inherited

Write the history to file.

template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::RecordResidualHistory ( void  )
inherited

Record the residual history.

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

Referenced by main().

template<class OperatorType, class VectorType , typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::SetOperator ( const OperatorType &  op)
inherited
template<class OperatorType, class VectorType, typename ValueType>
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::SetPreconditioner ( Solver< OperatorType, VectorType, ValueType > &  precond)
virtualinherited
template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::SetResidualNorm ( const int  resnorm)
inherited

Set the residual norm to L1, L2 or Inf norm resnorm == 1 L1 Norm resnorm == 2 L2 Norm (default) resnorm == 3 Inf Norm.

template<class OperatorType , class VectorType, typename ValueType >
void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Solve ( const VectorType &  rhs,
VectorType *  x 
)
virtualinherited
template<class OperatorType , class VectorType , typename ValueType >
void paralution::Chebyshev< OperatorType, VectorType, ValueType >::SolveNonPrecond_ ( const VectorType &  rhs,
VectorType *  x 
)
protectedvirtual

Non-preconditioner solution procedure.

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

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

Preconditioned solution procedure.

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

template<class OperatorType , class VectorType, typename ValueType >
void paralution::Solver< OperatorType, VectorType, ValueType >::SolveZeroSol ( const VectorType &  rhs,
VectorType *  x 
)
virtualinherited
template<class OperatorType , class VectorType , typename ValueType >
void paralution::IterativeLinearSolver< 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 from paralution::Solver< OperatorType, VectorType, ValueType >.

Referenced by paralution::BaseAMG< OperatorType, VectorType, ValueType >::Build(), paralution::AMG< OperatorType, VectorType, ValueType >::BuildSmoothers(), paralution::BaseAMG< OperatorType, VectorType, ValueType >::BuildSmoothers(), main(), mexFunction(), and paralution_solve().

Field Documentation

template<class OperatorType, class VectorType, typename ValueType>
bool paralution::Solver< OperatorType, VectorType, ValueType >::build_
protectedinherited

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

size_t paralution::ParalutionObj::global_obj_id
protectedinherited
template<class OperatorType, class VectorType, typename ValueType>
int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::index_
protectedinherited

Absolute maximum index of residual vector when using Linf norm.

template<class OperatorType, class VectorType, typename ValueType>
bool paralution::Chebyshev< OperatorType, VectorType, ValueType >::init_lambda_
private
template<class OperatorType, class VectorType, typename ValueType>
IterationControl paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::iter_ctrl_
protectedinherited

Iteration control (monitor)

template<class OperatorType, class VectorType, typename ValueType>
ValueType paralution::Chebyshev< OperatorType, VectorType, ValueType >::lambda_max_
private
template<class OperatorType, class VectorType, typename ValueType>
ValueType paralution::Chebyshev< OperatorType, VectorType, ValueType >::lambda_min_
private
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>
VectorType paralution::Chebyshev< OperatorType, VectorType, ValueType >::p_
private
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>
VectorType paralution::Chebyshev< OperatorType, VectorType, ValueType >::r_
private
template<class OperatorType, class VectorType, typename ValueType>
int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::res_norm_
protectedinherited

Residual norm res_norm = 1 L1 Norm res_norm = 2 L2 Norm res_norm = 3 Linf Norm.

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::Chebyshev< OperatorType, VectorType, ValueType >::z_
private

The documentation for this class was generated from the following files: