Diffpack Documentation

---

              Search  

---

PrecNone Class Reference

identity preconditioner for linear systems. More...

#include <Precond.h>

Inheritance diagram for PrecNone::

List of all members.

Public Methods
	PrecNone ()
	PrecNone (const Precond_prm &p)
virtual	~PrecNone ()
virtual bool	redim (const LinEqVector &)
virtual void	init (PrecBasis &)
virtual bool	ok () const
virtual void	apply (const LinEqVector &c, LinEqVector &d, TransposeMode=NOT_TRANSPOSED)
virtual String	description () const
virtual void	get (LinEqMatrix &precmat, String &precname) const
void	get (Precond_prm &precprm_) const

---

Detailed Description

identity preconditioner for linear systems.

NAME: PrecNone - identity preconditioner for linear systems

DESCRIPTION:

The class implements a preconditioner which equals the identity matrix. The class is useful when using preconditioners in a general set-up, but when the user will run a case without preconditioning.

---

Constructor & Destructor Documentation

PrecNone::PrecNone ( )

The constructor accepts a "Precond_prm" object. No further initialization is required.

PrecNone::PrecNone ( const Precond_prm & p )

See documentation of one of the overloaded constructor.

PrecNone::~PrecNone ( ) [virtual]

---

Member Function Documentation

void PrecNone::apply ( const LinEqVector & c, LinEqVector & d, TransposeMode tpmode = NOT_TRANSPOSED ) [inline, virtual]

computes the result of applying the current preconditoner to a "LinEqVector" object "c". The result is returned in "d". Depending on the "TransposeMode" parameter, the preconditoner can be used as is (default) or as transposed/conjugate transposed operator. Reimplemented from Precond.

String PrecNone::description ( ) const [virtual]

Reimplemented from Precond.

void PrecNone::get ( Precond_prm & precprm_ ) const [inline]

returns the current set of preconditoning parameters. If the chosen preconditioner is of algebraic type, an overloaded version can be used to access the preconditioning matrix. Reimplemented from Precond.

void PrecNone::get ( LinEqMatrix & precmat, String & precname ) const [virtual]

See documentation of one of the overloaded functions. Reimplemented from Precond.

void PrecNone::init ( PrecBasis & Apb ) [inline, virtual]

initializes the preconditioner, e.g. by computing an incomplete factorization. The function "init" should perform internal redimensioning if necessary. For algebraic preconditioners where C is based directly on A with the same sparsity pattern, C should be redimensioned by a "C.redim(A)" statement like we have for "LinEqVector" objects. The "Matrix"-heriarchy must then have a virtual makeItSimilar function (see "Vector"). Reimplemented from Precond.

bool PrecNone::ok ( ) const [inline, virtual]

returns "true" if the preconditioner is in normal state, otherwise it returns "false". Reimplemented from Precond.

bool PrecNone::redim ( const LinEqVector & x ) [inline, virtual]

redimensions the current preconditioner to match the supplied "LinEqVector" object. Reimplemented from Precond.

---

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

• Precond.h

---