SParse Approximate Inverse preconditioner. More...

#include <preconditioner_ai.hpp>

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

Public Member Functions
	SPAI ()

virtual	~SPAI ()

virtual void	Print (void) const
	Print information about the solver. More...

virtual void	Solve (const VectorType &rhs, VectorType *x)
	Solve Operator x = rhs. More...

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

virtual void	SetPrecondMatrixFormat (const unsigned int mat_format)

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

Private Attributes
OperatorType	SPAI_

bool	op_mat_format_
	Keep the precond matrix in CSR or not. More...

unsigned int	precond_mat_format_
	Precond matrix format. More...

Detailed Description

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

SParse Approximate Inverse preconditioner.

Constructor & Destructor Documentation

template<class OperatorType , class VectorType , typename ValueType >

paralution::SPAI< OperatorType, VectorType, ValueType >::SPAI ( void )

template<class OperatorType , class VectorType , typename ValueType >

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

virtual

Member Function Documentation

template<class OperatorType , class VectorType , typename ValueType >

void paralution::SPAI< 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::SPAI< 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::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::SPAI< 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::SPAI< 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::SPAI< 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::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::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::SPAI< OperatorType, VectorType, ValueType >::SetPrecondMatrixFormat ( const unsigned int mat_format )

virtual

template<class OperatorType , class VectorType , typename ValueType >

void paralution::SPAI< 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 >

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>

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>

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

protectedinherited

Pointer to the operator.

template<class OperatorType, class VectorType, typename ValueType>

bool paralution::SPAI< OperatorType, VectorType, ValueType >::op_mat_format_

private

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

private

Precond matrix format.

template<class OperatorType, class VectorType, typename ValueType>

OperatorType paralution::SPAI< OperatorType, VectorType, ValueType >::SPAI_

private

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/preconditioners/preconditioner_ai.hpp
solvers/preconditioners/preconditioner_ai.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

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