Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

dolfin::Preconditioner Class Reference

#include <Preconditioner.h>

Inheritance diagram for dolfin::Preconditioner:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Preconditioner ()
 Constructor.

virtual ~Preconditioner ()
 Destructor.

virtual void solve (Vector &x, const Vector &b)=0
 Solve linear system Ax = b for given right-hand side b.

Detailed Description

The class Preconditioner serves as a base class for all preconditioners, specifying the interface of a preconditioner.

A preconditioner solves (approximately) a linear system Ax = b for a given right-hand side b. Note that the matrix A is not given as an argument to the function solve(), since a preconditioner may be defined independent of any matrix. However, a matrix is typically given to the constructor of the preconditioner.

Constructor & Destructor Documentation

Preconditioner::Preconditioner (   ) 
 

Constructor.

Preconditioner::~Preconditioner (   )  [virtual]
 

Destructor.

Member Function Documentation

virtual void dolfin::Preconditioner::solve (  Vector &  x,
const Vector &  b
)  [pure virtual]
 

Solve linear system Ax = b for given right-hand side b.

Implemented in dolfin::BiCGSTAB, dolfin::CG, dolfin::FGMRES, dolfin::GaussSeidel, dolfin::GMRES, dolfin::Jacobi, dolfin::Richardson, and dolfin::SOR.

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


Documentation automatically generated with Doxygen on 10 Sep 2004.