Diffpack Documentation

---

              Search  

---

PrecUserDefInv Class Reference

user defined approximate inverse for preconditioning of linear systems. More...

#include <PrecAlgebraic.h>

Inheritance diagram for PrecUserDefInv::

List of all members.

Public Methods
	PrecUserDefInv (const Precond_prm &p)
virtual	~PrecUserDefInv ()
virtual void	apply (const LinEqVector &c, LinEqVector &d, TransposeMode tpmode=NOT_TRANSPOSED)
virtual int	getWork (const PrecondWork work_tp=APPLY_PREC_WORK) const
virtual String	description () const

---

Detailed Description

user defined approximate inverse for preconditioning of linear systems.

NAME: PrecUserDefInv - user defined approximate inverse for preconditioning of linear systems

DESCRIPTION:

The class implements a preconditioner, where the user explicitly supplies an approximate inverse as preconditioning matrix through a "PrecBasis" parameter to "init". It is assumed that the preconditioning step can be implemented in terms of a call of C's "prod".

---

Constructor & Destructor Documentation

PrecUserDefInv::PrecUserDefInv ( const Precond_prm & p )

The only constructor accepts a "Precond_prm" object.

PrecUserDefInv::~PrecUserDefInv ( ) [inline, virtual]

---

Member Function Documentation

void PrecUserDefInv::apply ( const LinEqVector & c, LinEqVector & d, TransposeMode tpmode = NOT_TRANSPOSED ) [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 PrecAlgebraic.

String PrecUserDefInv::description ( ) const [virtual]

Reimplemented from Precond.

int PrecUserDefInv::getWork ( const PrecondWork work_tp = APPLY_PREC_WORK ) const [virtual]

returns the work estimate for the last performed preconditioning operation. Reimplemented from Precond.

---

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

• PrecAlgebraic.h

---