Reference documentation for deal.II version Git 0491297983 2019-09-23 09:31:59 +0200
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Classes | Public Member Functions | Protected Attributes | List of all members
PETScWrappers::PreconditionEisenstat Class Reference

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

Inheritance diagram for PETScWrappers::PreconditionEisenstat:
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 PreconditionEisenstat ()=default
 
 PreconditionEisenstat (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
 
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 Eisenstat preconditioner, which implements SSOR on the diagonal block owned by each processor.

See the comment in the base class PreconditionerBase for when this preconditioner may or may not work.

Author
Wolfgang Bangerth, Timo Heister, 2004, 2011

Definition at line 411 of file petsc_precondition.h.

Constructor & Destructor Documentation

◆ PreconditionEisenstat() [1/2]

PETScWrappers::PreconditionEisenstat::PreconditionEisenstat ( )
default

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

◆ PreconditionEisenstat() [2/2]

PETScWrappers::PreconditionEisenstat::PreconditionEisenstat ( 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 308 of file petsc_precondition.cc.

Member Function Documentation

◆ initialize()

void PETScWrappers::PreconditionEisenstat::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 317 of file petsc_precondition.cc.

Member Data Documentation

◆ additional_data

AdditionalData PETScWrappers::PreconditionEisenstat::additional_data
protected

Store a copy of the flags for this particular preconditioner.

Definition at line 459 of file petsc_precondition.h.


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