PETScWrappers::PreconditionerBase Class Reference
[PETScWrappers]

Inheritance diagram for PETScWrappers::PreconditionerBase:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 PreconditionerBase (const MatrixBase &matrix)
virtual ~PreconditionerBase ()

Protected Member Functions

 operator const Mat () const
virtual void set_preconditioner_type (PC &pc) const =0

Protected Attributes

const Mat matrix

Friends

class SolverBase


Detailed Description

Base class for preconditioner classes using the PETSc functionality. The classes in this hierarchy don't do a whole lot, except for providing a function that sets the preconditioner and certain parameters on the preconditioning context of the solver. These classes are basically here only to allow a similar interface as already used for the deal.II solver and preconditioner classes.

Note that derived classes only provide interfaces to the relevant functionality of PETSc. PETSc does not implement all preconditioners for all matrix types. In particular, some preconditioners are not going to work for parallel jobs, such as for example the ILU preconditioner.

Author:
Wolfgang Bangerth, 2004

Constructor & Destructor Documentation

PETScWrappers::PreconditionerBase::PreconditionerBase ( const MatrixBase matrix  ) 

Constructor. Take a pointer to the matrix from which the preconditioner shall be constructed.

virtual PETScWrappers::PreconditionerBase::~PreconditionerBase (  )  [virtual]

Destructor.


Member Function Documentation

PETScWrappers::PreconditionerBase::operator const Mat (  )  const [protected]

Conversion operator to get a representation of the matrix that represents this preconditioner. We use this inside the actual solver, where we need to pass this matrix to the PETSc solvers.

virtual void PETScWrappers::PreconditionerBase::set_preconditioner_type ( PC &  pc  )  const [protected, pure virtual]


Friends And Related Function Documentation

friend class SolverBase [friend]

Make the solver class a friend, since it needs to call the conversion operator.


Member Data Documentation

A pointer to the matrix that acts as a preconditioner.


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

deal.II documentation generated on Sat Aug 15 16:52:43 2009 by doxygen 1.5.9