Classes | Public Member Functions | Protected Attributes

PETScWrappers::PreconditionBlockJacobi Class Reference
[PETScWrappers]

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

List of all members.

Classes

struct  AdditionalData

Public Member Functions

 PreconditionBlockJacobi ()
 PreconditionBlockJacobi (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
void initialize (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())

Protected Attributes

AdditionalData additional_data

Detailed Description

A class that implements the interface to use the PETSc Block Jacobi preconditioner. The blocking structure of the matrix is determined by the association of degrees of freedom to the individual processors in an MPI-parallel job. If you use this preconditioner on a sequential job (or an MPI job with only one process) then the entire matrix is the only block.

By default, PETSc uses an ILU(0) decomposition of each diagonal block of the matrix for preconditioning. This can be changed, as is explained in the relevant section of the PETSc manual, but is not implemented here.

See the comment in the base class PreconditionerBase for when this preconditioner may or may not work.

Author:
Wolfgang Bangerth, Timo Heister, 2004, 2011

Definition at line 196 of file petsc_precondition.h.


Constructor & Destructor Documentation

PETScWrappers::PreconditionBlockJacobi::PreconditionBlockJacobi (  )

Empty Constructor. You need to call initialize() before using this object.

PETScWrappers::PreconditionBlockJacobi::PreconditionBlockJacobi ( const MatrixBase matrix,
const AdditionalData additional_data = AdditionalData() 
)

Constructor. Take the matrix which is used to form the preconditioner, and additional flags if there are any.


Member Function Documentation

void PETScWrappers::PreconditionBlockJacobi::initialize ( const MatrixBase matrix,
const AdditionalData additional_data = AdditionalData() 
)

Initializes the preconditioner object and calculate all data that is necessary for applying it in a solver. This function is automatically called when calling the constructor with the same arguments and is only used if you create the preconditioner without arguments.


Member Data Documentation

Store a copy of the flags for this particular preconditioner.

Definition at line 242 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