Diffpack Documentation

---

              Search  

---

AMG Class Reference

solution of linear systems by algebraic multi-grid. More...

#include <AMG.h>

Inheritance diagram for AMG::

List of all members.

Public Methods
	AMG ()
	AMG (const LinEqSolver_prm &pm)
	~AMG ()
virtual bool	ok () const
virtual bool	solve (LinEqSystem &system)
virtual int	getWork (const LinEqSysWork work_tp=TOTAL_WORK) const
virtual real	getStorage (const LinEqSysStorage storage_tp=TOTAL_STORAGE) const
virtual String	description () const

---

Detailed Description

solution of linear systems by algebraic multi-grid.

NAME: AMG - solution of linear systems by algebraic multi-grid

DESCRIPTION:

The class implements the Algebraic Multigrid (AMG) method for solving systems of linear equations. The system is represented as a class "LinEqSystem" object. Usually, an object of type "AMG" is created on basis of the parameter object "LinEqSolver_prm" using the function "LinEqSolver_prm create".

---

Constructor & Destructor Documentation

AMG::AMG ( )

Since no parameters are needed for this method, the default constructor takes no arguments. For the sake of compatibility, there is also a constructor accepting a "LinEqSolver_prm" object.

AMG::AMG ( const LinEqSolver_prm & pm )

See documentation of one of the overloaded constructor.

AMG::~AMG ( ) [inline]

---

Member Function Documentation

String AMG::description ( ) const [virtual]

Reimplemented from LinEqSolver.

real AMG::getStorage ( const LinEqSysStorage storage_tp = TOTAL_STORAGE ) const [virtual]

returns the storage estimate for the last solve. The argument "storage_tp" can be used to extract more detailed information. Reimplemented from LinEqSolver.

int AMG::getWork ( const LinEqSysWork work_tp = TOTAL_WORK ) const [virtual]

returns the work estimate for the last solve. The argument "work_tp" can be used to extract more detailed information. Reimplemented from LinEqSolver.

bool AMG::ok ( ) const [inline, virtual]

returns "true" if the solver is in a healthy state, i.e., if a "LinEqSystem" object is attached. If not, the value "false" is returned. Reimplemented from LinEqSolver.

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

solves the linear system given as argument. There is no need for explicit redimensioning of internal data structure, this is automatically done by "solve". Reimplemented from LinEqSolver.

---

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

• AMG.h

---