![]() |
Reference documentation for deal.II version Git 52fd159989 2021-02-28 09:21:27 -0700
|
#include <deal.II/lac/petsc_precondition.h>
Classes | |
struct | AdditionalData |
Public Member Functions | |
PreconditionBoomerAMG ()=default | |
PreconditionBoomerAMG (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData()) | |
PreconditionBoomerAMG (const MPI_Comm &communicator, 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 | initialize () |
void | create_pc () |
operator Mat () const | |
Protected Attributes | |
AdditionalData | additional_data |
PC | pc |
Mat | matrix |
A class that implements the interface to use the BoomerAMG algebraic multigrid preconditioner from the HYPRE suite. Note that PETSc has to be configured with HYPRE (e.g. with --download-hypre=1).
The preconditioner does support parallel distributed computations. See step-40 for an example.
Definition at line 676 of file petsc_precondition.h.
|
default |
Empty Constructor. You need to call initialize() before using this object.
PETScWrappers::PreconditionBoomerAMG::PreconditionBoomerAMG | ( | 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 472 of file petsc_precondition.cc.
PETScWrappers::PreconditionBoomerAMG::PreconditionBoomerAMG | ( | 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 452 of file petsc_precondition.cc.
void PETScWrappers::PreconditionBoomerAMG::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 533 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 480 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 774 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.