Reference documentation for deal.II version Git f0d9923401 2020-09-28 19:47:38 -0600
PETScWrappers::PreconditionJacobi Class Reference

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

Inheritance diagram for PETScWrappers::PreconditionJacobi:
[legend]

## Public Member Functions

PreconditionJacobi ()=default

void clear ()

void vmult (VectorBase &dst, const VectorBase &src) const

void Tvmult (VectorBase &dst, const VectorBase &src) const

const PC & get_pc () const

## Protected Member Functions

void initialize ()

void create_pc ()

operator Mat () const

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.

Definition at line 137 of file petsc_precondition.h.

## ◆ PreconditionJacobi() [1/3]

 PETScWrappers::PreconditionJacobi::PreconditionJacobi ( )
default

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 139 of file petsc_precondition.cc.

## ◆ 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 126 of file petsc_precondition.cc.

## ◆ 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 158 of file petsc_precondition.cc.

## ◆ initialize() [2/2]

 void PreconditionJacobi< MatrixType >::initialize ( )
protected

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 146 of file petsc_precondition.cc.

## ◆ clear()

 void PETScWrappers::PreconditionerBase::clear ( )
inherited

Destroys the preconditioner, leaving an object like just after having called the constructor.

Definition at line 52 of file petsc_precondition.cc.

## ◆ vmult()

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

Apply the preconditioner once to the given src vector.

Definition at line 66 of file petsc_precondition.cc.

## ◆ Tvmult()

 void PETScWrappers::PreconditionerBase::Tvmult ( VectorBase & dst, const VectorBase & src ) const
inherited

Apply the transpose preconditioner once to the given src vector.

Definition at line 76 of file petsc_precondition.cc.

## ◆ get_pc()

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

Definition at line 113 of file petsc_precondition.cc.

## ◆ create_pc()

 void PETScWrappers::PreconditionerBase::create_pc ( )
protectedinherited

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

Definition at line 86 of file petsc_precondition.cc.

## ◆ operator Mat()

 PETScWrappers::PreconditionerBase::operator Mat ( ) const
protectedinherited

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.

Definition at line 119 of file petsc_precondition.cc.

## Member Data Documentation

protected

Store a copy of the flags for this particular preconditioner.

Definition at line 184 of file petsc_precondition.h.

## ◆ pc

 PC PETScWrappers::PreconditionerBase::pc
protectedinherited

the PETSc preconditioner object

Definition at line 99 of file petsc_precondition.h.

## ◆ matrix

 Mat PETScWrappers::PreconditionerBase::matrix
protectedinherited

A pointer to the matrix that acts as a preconditioner.

Definition at line 104 of file petsc_precondition.h.

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