Public Member Functions | Protected Member Functions | Protected Attributes | Friends

PETScWrappers::PreconditionerBase Class Reference
[PETScWrappers]

Inheritance diagram for PETScWrappers::PreconditionerBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 PreconditionerBase ()
virtual ~PreconditionerBase ()
void vmult (VectorBase &dst, const VectorBase &src) const
const PC & get_pc () const

Protected Member Functions

void create_pc ()
 operator Mat () const

Protected Attributes

PC pc
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, Timo Heister, 2004, 2011

Definition at line 51 of file petsc_precondition.h.


Constructor & Destructor Documentation

PETScWrappers::PreconditionerBase::PreconditionerBase (  )

Constructor.

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

Destructor.


Member Function Documentation

void PETScWrappers::PreconditionerBase::vmult ( VectorBase dst,
const VectorBase src 
) const

Apply the preconditioner once to the given src vector.

const PC& PETScWrappers::PreconditionerBase::get_pc (  ) const

Gives access to the underlying PETSc object.

void PETScWrappers::PreconditionerBase::create_pc (  ) [protected]

Internal function to create the PETSc preconditioner object. Fails if called twice.

PETScWrappers::PreconditionerBase::operator 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.


Friends And Related Function Documentation

friend class SolverBase [friend]

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

Definition at line 112 of file petsc_precondition.h.


Member Data Documentation

the PETSc preconditioner object

Definition at line 82 of file petsc_precondition.h.

A pointer to the matrix that acts as a preconditioner.

Definition at line 88 of file petsc_precondition.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:15 by doxygen 1.7.2