Reference documentation for deal.II version Git cb0bd54b52 2019-09-21 16:31:22 -0400
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PETScWrappers::PreconditionJacobi Class Reference

#include <deal.II/lac/petsc_precondition.h>

Inheritance diagram for PETScWrappers::PreconditionJacobi:


struct  AdditionalData

Public Member Functions

 PreconditionJacobi ()=default
 PreconditionJacobi (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
 PreconditionJacobi (const MPI_Comm communicator, const AdditionalData &additional_data=AdditionalData())
void initialize (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
- Public Member Functions inherited from PETScWrappers::PreconditionerBase
 PreconditionerBase ()
virtual ~PreconditionerBase ()
void clear ()
void vmult (VectorBase &dst, const VectorBase &src) const
const PC & get_pc () const

Protected Member Functions

void initialize ()
- Protected Member Functions inherited from PETScWrappers::PreconditionerBase
void create_pc ()
 operator Mat () const

Protected Attributes

AdditionalData additional_data
- Protected Attributes inherited from PETScWrappers::PreconditionerBase
PC pc
Mat matrix

Detailed Description

A class that implements the interface to use the PETSc Jacobi preconditioner.

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

Wolfgang Bangerth, Timo Heister, 2004, 2011

Definition at line 133 of file petsc_precondition.h.

Constructor & Destructor Documentation

◆ PreconditionJacobi() [1/3]

PETScWrappers::PreconditionJacobi::PreconditionJacobi ( )

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

◆ PreconditionJacobi() [2/3]

PreconditionJacobi< MatrixType >::PreconditionJacobi ( 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.

Definition at line 129 of file

◆ PreconditionJacobi() [3/3]

PreconditionJacobi< MatrixType >::PreconditionJacobi ( const MPI_Comm  communicator,
const AdditionalData additional_data = AdditionalData() 

Same as above but without setting a matrix to form the preconditioner. Intended to be used with SLEPc objects.

Definition at line 116 of file

Member Function Documentation

◆ initialize() [1/2]

void PreconditionJacobi< MatrixType >::initialize ( const MatrixBase matrix,
const AdditionalData additional_data = AdditionalData() 

Initialize 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.

Definition at line 148 of file

◆ initialize() [2/2]

void PreconditionJacobi< MatrixType >::initialize ( )

Initialize the preconditioner object without knowing a particular matrix. This function sets up appropriate parameters to the underlying PETSc object after it has been created.

Definition at line 136 of file

Member Data Documentation

◆ additional_data

AdditionalData PETScWrappers::PreconditionJacobi::additional_data

Store a copy of the flags for this particular preconditioner.

Definition at line 180 of file petsc_precondition.h.

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