Reference documentation for deal.II version Git f15f581df6 2020-07-10 15:30:09 -0400
\(\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 Attributes | List of all members
PETScWrappers::PreconditionLU Class Reference

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

Inheritance diagram for PETScWrappers::PreconditionLU:


struct  AdditionalData

Public Member Functions

 PreconditionLU ()=default
 PreconditionLU (const MatrixBase &matrix, 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
void Tvmult (VectorBase &dst, const VectorBase &src) const
const PC & get_pc () const

Protected Attributes

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

Additional Inherited Members

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

Detailed Description

A class that implements the interface to use the PETSc LU preconditioner (PCLU). Unlike classes like PreconditionILU, this class usually (depending on the settings) performs an exact factorization of the matrix, so it is not necessary to wrap it in an iterative solver. This class is typically used with SolverPreOnly to get a direct solver. Alternatively, you can use PreconditionerBase::vmult() directly.

This is not a parallel preconditioner so it only works in serial computations with a single processor.

Definition at line 597 of file petsc_precondition.h.

Constructor & Destructor Documentation

◆ PreconditionLU() [1/2]

PETScWrappers::PreconditionLU::PreconditionLU ( )

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

◆ PreconditionLU() [2/2]

PreconditionLU< number >::PreconditionLU ( 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 711 of file

Member Function Documentation

◆ initialize()

void PreconditionLU< number >::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 719 of file

Member Data Documentation

◆ additional_data

AdditionalData PETScWrappers::PreconditionLU::additional_data

Store a copy of the flags for this particular preconditioner.

Definition at line 661 of file petsc_precondition.h.

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