Reference documentation for deal.II version Git b8d130ac44 2020-08-12 22:11:34 +0200
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
PETScWrappers::PreconditionerBase Class Reference

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

Inheritance diagram for PETScWrappers::PreconditionerBase:

Public Member Functions

 PreconditionerBase ()
virtual ~PreconditionerBase ()
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 create_pc ()
 operator Mat () const

Protected Attributes

PC pc
Mat matrix


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.

Definition at line 56 of file petsc_precondition.h.

Constructor & Destructor Documentation

◆ PreconditionerBase()

PETScWrappers::PreconditionerBase::PreconditionerBase ( )


Definition at line 36 of file

◆ ~PreconditionerBase()

PETScWrappers::PreconditionerBase::~PreconditionerBase ( )


Definition at line 41 of file

Member Function Documentation

◆ clear()

void PETScWrappers::PreconditionerBase::clear ( )

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

Definition at line 52 of file

◆ vmult()

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

Apply the preconditioner once to the given src vector.

Definition at line 66 of file

◆ Tvmult()

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

Apply the transpose preconditioner once to the given src vector.

Definition at line 76 of file

◆ get_pc()

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

Give access to the underlying PETSc object.

Definition at line 113 of file

◆ create_pc()

void PETScWrappers::PreconditionerBase::create_pc ( )

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

Definition at line 86 of file

◆ operator Mat()

PETScWrappers::PreconditionerBase::operator Mat ( ) const

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

Friends And Related Function Documentation

◆ SolverBase

friend class SolverBase

Definition at line 122 of file petsc_precondition.h.

Member Data Documentation

◆ pc

PC PETScWrappers::PreconditionerBase::pc

the PETSc preconditioner object

Definition at line 99 of file petsc_precondition.h.

◆ matrix

Mat PETScWrappers::PreconditionerBase::matrix

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: