Reference documentation for deal.II version Git f0d9923401 2020-09-28 19:47:38 -0600
\(\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\}}\)
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PETScWrappers::PreconditionSOR Class Reference

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

Inheritance diagram for PETScWrappers::PreconditionSOR:
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 PreconditionSOR ()=default
 
 PreconditionSOR (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
 
void initialize (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData())
 
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

AdditionalData additional_data
 
PC pc
 
Mat matrix
 

Detailed Description

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

Note
Only works in serial with a PETScWrappers::SparseMatrix.

Definition at line 288 of file petsc_precondition.h.

Constructor & Destructor Documentation

◆ PreconditionSOR() [1/2]

PETScWrappers::PreconditionSOR::PreconditionSOR ( )
default

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

◆ PreconditionSOR() [2/2]

PreconditionSOR< MatrixType >::PreconditionSOR ( 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 232 of file petsc_precondition.cc.

Member Function Documentation

◆ initialize()

void PreconditionSOR< 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 240 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

Give access to the underlying PETSc object.

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

◆ additional_data

AdditionalData PETScWrappers::PreconditionSOR::additional_data
protected

Store a copy of the flags for this particular preconditioner.

Definition at line 335 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: