Diffpack Documentation

---

              Search  

---

PrecJacobi Class Reference

Jacobi preconditioner for linear systems. More...

#include <PrecAlgebraic.h>

Inheritance diagram for PrecJacobi::

List of all members.

Public Methods
	PrecJacobi (const Precond_prm &p)
virtual	~PrecJacobi ()
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

Jacobi preconditioner for linear systems.

NAME: PrecJacobi - Jacobi preconditioner for linear systems

DESCRIPTION:

Traditional preconditioner in terms of the inner system imposed by the Jacobi splitting. This preconditioning procedure is also referred to as diagonal scaling.

---

Constructor & Destructor Documentation

PrecJacobi::PrecJacobi ( const Precond_prm & p )

The only constructor accepts a "Precond_prm" object.

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

---

Member Function Documentation

void PrecJacobi::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 PrecJacobi::description ( ) const [virtual]

Reimplemented from Precond.

int PrecJacobi::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

---