Reference documentation for deal.II version 9.2.0
|
#include <deal.II/lac/petsc_precondition.h>
Classes | |
struct | AdditionalData |
Public Member Functions | |
PreconditionJacobi ()=default | |
PreconditionJacobi (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData()) | |
PreconditionJacobi (const MPI_Comm communicator, 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 Member Functions | |
void | initialize () |
Protected Member Functions inherited from PETScWrappers::PreconditionerBase | |
void | create_pc () |
operator Mat () const | |
Protected Attributes | |
AdditionalData | additional_data |
Protected Attributes inherited from PETScWrappers::PreconditionerBase | |
PC | pc |
Mat | matrix |
A class that implements the interface to use the PETSc Jacobi preconditioner.
See the comment in the base class PreconditionerBase for when this preconditioner may or may not work.
Definition at line 139 of file petsc_precondition.h.
|
default |
Empty Constructor. You need to call initialize() before using this object.
PreconditionJacobi< MatrixType >::PreconditionJacobi | ( | 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 139 of file petsc_precondition.cc.
PreconditionJacobi< MatrixType >::PreconditionJacobi | ( | const MPI_Comm | communicator, |
const AdditionalData & | additional_data = AdditionalData() |
||
) |
Same as above but without setting a matrix to form the preconditioner. Intended to be used with SLEPc objects.
Definition at line 126 of file petsc_precondition.cc.
void PreconditionJacobi< 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 158 of file petsc_precondition.cc.
|
protected |
Initialize the preconditioner object without knowing a particular matrix. This function sets up appropriate parameters to the underlying PETSc object after it has been created.
Definition at line 146 of file petsc_precondition.cc.
|
protected |
Store a copy of the flags for this particular preconditioner.
Definition at line 186 of file petsc_precondition.h.