Diffpack Documentation

---

              Search  

---

Jacobi Class Reference

iterative method for matrix systems. More...

#include <BasicIter.h>

Inheritance diagram for Jacobi::

List of all members.

Public Methods
	Jacobi ()
	Jacobi (const LinEqSolver_prm &pm)
	~Jacobi ()
virtual bool	solve (LinEqSystem &system)
virtual String	description () const

---

Detailed Description

iterative method for matrix systems.

NAME: Jacobi - iterative method for matrix systems

DESCRIPTION:

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

---

Constructor & Destructor Documentation

Jacobi::Jacobi ( )

There is one default constructor without arguments since no parameters are needed for the Jacobi iteration. For the sake comaptibility, there is also a constructor accepting 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.

Jacobi::Jacobi ( const LinEqSolver_prm & pm )

See documentation of one of the overloaded constructor.

Jacobi::~Jacobi ( ) [inline]

---

Member Function Documentation

String Jacobi::description ( ) const [virtual]

Reimplemented from LinEqSolver.

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

solve a system of linear equations using the Jacobi iteration.. Reimplemented from BasicItSolver.

---

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

• BasicIter.h

---