Base class for all linear (iterative) solvers. More...

#include <solver.hpp>

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

Public Member Functions
	IterativeLinearSolver ()

virtual	~IterativeLinearSolver ()

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	Print (void) const =0
	Print information about the solver. More...

virtual void	SolveZeroSol (const VectorType &rhs, VectorType *x)
	Solve Operator x = rhs; but set first the init x = 0. More...

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	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)=0
	Non-preconditioner solution procedure. More...

virtual void	SolvePrecond_ (const VectorType &rhs, VectorType *x)=0
	Preconditioned solution procedure. More...

ValueType	Norm (const VectorType &vec)
	Computes the vector norm. More...

virtual void	PrintStart_ (void) const =0
	Print starting msg of the solver. More...

virtual void	PrintEnd_ (void) const =0
	Print ending msg of the solver. More...

virtual void	MoveToHostLocalData_ (void)=0
	Move all local data to the host. More...

virtual void	MoveToAcceleratorLocalData_ (void)=0
	Move all local data to the accelerator. 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< 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

Detailed Description

template<class OperatorType, class VectorType, typename ValueType>
class paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >

Base class for all linear (iterative) solvers.

Constructor & Destructor Documentation

template<class OperatorType , class VectorType , typename ValueType >

paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::IterativeLinearSolver ( )

template<class OperatorType , class VectorType , typename ValueType >

paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::~IterativeLinearSolver ( )

virtual

Member Function Documentation

template<class OperatorType , class VectorType , typename ValueType >

void paralution::Solver< OperatorType, VectorType, ValueType >::Build ( void )

virtualinherited

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

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >

void paralution::Solver< OperatorType, VectorType, ValueType >::Clear ( void )

virtualinherited

Clear (free all local data) the solver.

Implements paralution::ParalutionObj.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >

int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetAmaxResidualIndex ( void )

virtual

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 )

virtual

Return the current residual.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >

int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetIterationCount ( void )

virtual

Return the iteration count.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >

int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::GetSolverStatus ( void )

virtual

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
	)

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
	)

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 )

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 )

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
	)

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>

virtual void paralution::Solver< OperatorType, VectorType, ValueType >::MoveToAcceleratorLocalData_ ( void )

protectedpure virtualinherited

Move all local data to the accelerator.

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>

virtual void paralution::Solver< OperatorType, VectorType, ValueType >::MoveToHostLocalData_ ( void )

protectedpure virtualinherited

Move all local data to the host.

template<class OperatorType , class VectorType, typename ValueType >

ValueType paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Norm ( const VectorType & vec )

protected

Computes the vector norm.

template<class OperatorType, class VectorType, typename ValueType>

virtual void paralution::Solver< OperatorType, VectorType, ValueType >::Print ( void ) const

pure virtualinherited

Print information about the solver.

template<class OperatorType, class VectorType, typename ValueType>

virtual void paralution::Solver< OperatorType, VectorType, ValueType >::PrintEnd_ ( void ) const

protectedpure virtualinherited

Print ending msg of the solver.

template<class OperatorType, class VectorType, typename ValueType>

virtual void paralution::Solver< OperatorType, VectorType, ValueType >::PrintStart_ ( void ) const

protectedpure virtualinherited

Print starting msg of the solver.

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::IterativeLinearSolver< OperatorType, VectorType, ValueType >::RecordHistory ( const std::string filename ) const

Write the history to file.

template<class OperatorType , class VectorType , typename ValueType >

void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::RecordResidualHistory ( void )

Record the residual history.

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::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::IterativeLinearSolver< OperatorType, VectorType, ValueType >::SetPreconditioner ( Solver< OperatorType, VectorType, ValueType > & precond )

virtual

Set a preconditioner of the linear solver.

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

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

template<class OperatorType , class VectorType , typename ValueType >

void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::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.

template<class OperatorType , class VectorType, typename ValueType >

void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Solve	(	const VectorType &	rhs,
		VectorType *	x
	)

virtual

Solve Operator x = rhs.

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

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

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

template<class OperatorType, class VectorType, typename ValueType>

virtual void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::SolveNonPrecond_	(	const VectorType &	rhs,
		VectorType *	x
	)

protectedpure virtual

Non-preconditioner solution procedure.

template<class OperatorType, class VectorType, typename ValueType>

virtual void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::SolvePrecond_	(	const VectorType &	rhs,
		VectorType *	x
	)

protectedpure virtual

Preconditioned solution procedure.

template<class OperatorType , class VectorType, typename ValueType >

void paralution::Solver< OperatorType, VectorType, ValueType >::SolveZeroSol	(	const VectorType &	rhs,
		VectorType *	x
	)

virtualinherited

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

Reimplemented in paralution::Preconditioner< OperatorType, VectorType, ValueType >, paralution::Preconditioner< paralution::LocalMatrix< ValueTypeL >, paralution::LocalVector< ValueTypeL >, ValueTypeL >, and paralution::Preconditioner< paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueTypeH >, ValueTypeH >.

template<class OperatorType , class VectorType , typename ValueType >

void paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::Verbose ( const int verb = 1 )

virtual

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

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

template<class OperatorType, class VectorType, typename ValueType>

int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::index_

protected

Absolute maximum index of residual vector when using Linf norm.

template<class OperatorType, class VectorType, typename ValueType>

IterationControl paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::iter_ctrl_

protected

Iteration control (monitor)

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>

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>

int paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >::res_norm_

protected

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;.

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

solvers/solver.hpp
solvers/solver.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class OperatorType, class VectorType, typename ValueType> class paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<class OperatorType, class VectorType, typename ValueType>
class paralution::IterativeLinearSolver< OperatorType, VectorType, ValueType >