Diffpack Documentation

---

              Search  

---

SOR Class Reference

iterative method for matrix systems. More...

#include <BasicIter.h>

Inheritance diagram for SOR::

List of all members.

Public Methods
	SOR (real omega)
	SOR (const LinEqSolver_prm &pm)
	~SOR ()
virtual bool	solve (LinEqSystem &system)
virtual void	performance (LinEqStatBlk &performance_status)
virtual String	description () const

---

Detailed Description

iterative method for matrix systems.

NAME: SOR - iterative method for matrix systems

DESCRIPTION:

The class implements the SOR iteration for solving systems of linear equations. The system is represented as a class "LinEqSystem" object. Usually, an object of type "SOR" is created on basis of the parameter object "LinEqSolver_prm" using the function "LinEqSolver_prm create".

---

Constructor & Destructor Documentation

SOR::SOR ( real omega )

There are two constructors taking the parameters that are required to initialize the object. One of these accept the relaxation parameter "omega" directly, while the other reads this value from a "LinEqSolver_prm" object. Internal "LinEqVector" attributes are not properly initialized by the constructor. These are initialized by the "redim" function which is called from "solve". Thus, the user of this class need not be careful with initialization of objects: The constructor and the "solve" function will take care of it.

SOR::SOR ( const LinEqSolver_prm & pm )

See documentation of one of the overloaded constructor.

SOR::~SOR ( ) [inline]

---

Member Function Documentation

String SOR::description ( ) const [virtual]

Reimplemented from LinEqSolver.

void SOR::performance ( LinEqStatBlk & performance_status ) [virtual]

fills in the "LinEqStatBlk" object with relevant statistics regarding the last solve. Reimplemented from IterativeSolver.

bool SOR::solve ( LinEqSystem & system ) [virtual]

solve a system of linear equations using the SOR method. Reimplemented from BasicItSolver.

---

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

• BasicIter.h

---