The base class for all solvers and preconditioners. More...

#include <solver.hpp>

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

Public Member Functions
	Solver ()

virtual	~Solver ()

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	Solve (const VectorType &rhs, VectorType *x)=0
	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...

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

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	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
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::Solver< OperatorType, VectorType, ValueType >

The base class for all solvers and preconditioners.

Constructor & Destructor Documentation

template<class OperatorType , class VectorType , typename ValueType >

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

template<class OperatorType , class VectorType , typename ValueType >

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

virtual

Member Function Documentation

template<class OperatorType , class VectorType , typename ValueType >

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

virtual

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 )

virtual

Clear (free all local data) the solver.

Implements paralution::ParalutionObj.

Referenced by paralution_fortran_solve().

template<class OperatorType , class VectorType , typename ValueType >

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

virtual

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 virtual

Move all local data to the accelerator.

template<class OperatorType , class VectorType , typename ValueType >

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

virtual

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 virtual

Move all local data to the host.

template<class OperatorType, class VectorType, typename ValueType>

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

pure virtual

Print information about the solver.

template<class OperatorType, class VectorType, typename ValueType>

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

protectedpure virtual

Print ending msg of the solver.

template<class OperatorType, class VectorType, typename ValueType>

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

protectedpure virtual

Print starting msg of the solver.

template<class OperatorType , class VectorType , typename ValueType >

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

virtual

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 )

virtual

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 )

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>

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

pure virtual

Solve Operator x = rhs.

template<class OperatorType , class VectorType, typename ValueType >

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

virtual

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::Solver< 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 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>

bool paralution::Solver< OperatorType, VectorType, ValueType >::build_

protected

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>

const OperatorType* paralution::Solver< OperatorType, VectorType, ValueType >::op_

protected

Pointer to the operator.

template<class OperatorType, class VectorType, typename ValueType>

LocalVector<int> paralution::Solver< OperatorType, VectorType, ValueType >::permutation_

protected

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_

protected

Pointer to the defined preconditioner.

template<class OperatorType, class VectorType, typename ValueType>

int paralution::Solver< OperatorType, VectorType, ValueType >::verb_

protected

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::Solver< OperatorType, VectorType, ValueType >

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

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