Reference documentation for deal.II version Git f0d9923401 20200928 19:47:38 0600

#include <deal.II/lac/petsc_precondition.h>
Classes  
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()) 
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 
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.
Definition at line 597 of file petsc_precondition.h.

default 
Empty Constructor. You need to call initialize() before using this object.
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 petsc_precondition.cc.
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 petsc_precondition.cc.

inherited 
Destroys the preconditioner, leaving an object like just after having called the constructor.
Definition at line 52 of file petsc_precondition.cc.

inherited 
Apply the preconditioner once to the given src vector.
Definition at line 66 of file petsc_precondition.cc.

inherited 
Apply the transpose preconditioner once to the given src vector.
Definition at line 76 of file petsc_precondition.cc.

inherited 
Give access to the underlying PETSc object.
Definition at line 113 of file petsc_precondition.cc.

protectedinherited 
Internal function to create the PETSc preconditioner object. Fails if called twice.
Definition at line 86 of file petsc_precondition.cc.

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.

protected 
Store a copy of the flags for this particular preconditioner.
Definition at line 661 of file petsc_precondition.h.

protectedinherited 
the PETSc preconditioner object
Definition at line 99 of file petsc_precondition.h.

protectedinherited 
A pointer to the matrix that acts as a preconditioner.
Definition at line 104 of file petsc_precondition.h.