Diag_Precond Class Reference

Diagonal preconditioner class. More...

#include <diag_precond.hpp>

Inheritance diagram for Diag_Precond:

Public Member Functions
	Diag_Precond ()
	Constructor for a diagonal preconditioner. More...
	~Diag_Precond ()
	Destructor. More...
Diag_Precond *	copy (void) const
	Get a new copy of preconditiner. More...
void	prepare (const CRowMatrix &A)
	Prepare preconditioner for matrices with non-zero pattern equal to A. More...
void	construct (const CRowMatrix &A)
	Construct preconditioner for matrix A. More...
void	clear (void)
	Clear preconditioner. More...
bool	is_prepared (void) const
	Return false if prepare is needed. More...
std::string	typestring (void) const
	Return string indicating type of preconditioner. More...
void	solve (Vector &x, const Vector &b) const
	Solve M* x = b and return x. More...
Public Member Functions inherited from Precond
virtual	~Precond ()
	Virtual destructor. More...

Detailed Description

Diagonal preconditioner class.

Constructor & Destructor Documentation

Diag_Precond()

Diag_Precond::Diag_Precond

(

)

Constructor for a diagonal preconditioner.

~Diag_Precond()

Diag_Precond::~Diag_Precond ( )

inline

Destructor.

Member Function Documentation

clear()

void Diag_Precond::clear ( void  )

virtual

Clear preconditioner.

Clears preconditioner. Both prepare() and construct() functions have to be called after this.

Implements Precond.

construct()

void Diag_Precond::construct ( const CRowMatrix &  A )

virtual

Construct preconditioner for matrix A.

Implements Precond.

copy()

Diag_Precond* Diag_Precond::copy ( void  ) const

inlinevirtual

Get a new copy of preconditiner.

Does not copy matrix.

Implements Precond.

is_prepared()

bool Diag_Precond::is_prepared ( void  ) const

inlinevirtual

Return false if prepare is needed.

Returns true if prepare is not needed and false if it is.

Implements Precond.

prepare()

void Diag_Precond::prepare ( const CRowMatrix &  A )

virtual

Prepare preconditioner for matrices with non-zero pattern equal to A.

Implements Precond.

solve()

void Diag_Precond::solve ( Vector &  x, const Vector &  b  ) const

virtual

Solve M* x = b and return x.

Implements Precond.

typestring()

std::string Diag_Precond::typestring ( void  ) const

virtual

Return string indicating type of preconditioner.

Implements Precond.

---

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

• diag_precond.hpp
• diag_precond.cpp