Diffpack Documentation

---

              Search  

---

PrecSOR Class Reference

SOR preconditioner for linear systems. More...

#include <PrecAlgebraic.h>

Inheritance diagram for PrecSOR::

List of all members.

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

---

Detailed Description

SOR preconditioner for linear systems.

NAME: PrecSOR - SOR preconditioner for linear systems

DESCRIPTION:

Traditional preconditioner in terms of the inner system imposed by the SOR splitting. (In general, this preconditioner will not improve the convergence rate of your iterative solver).

---

Constructor & Destructor Documentation

PrecSOR::PrecSOR ( const Precond_prm & p )

The only constructor accepts a "Precond_prm" object.

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

---

Member Function Documentation

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

Reimplemented from Precond.

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

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

void PrecSOR::performance ( PrecondStatistics & precStat ) [virtual]

records preconditioning statistics in the supplied "PrecondStatistics" object. This object is usually a part of a "LinEqStatBlk" object which is used to collect and performance statistics. Reimplemented from Precond.

---

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

• PrecAlgebraic.h

---