Reference documentation for deal.II version 9.2.0
|
#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()) |
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 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 686 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.
|
protected |
Store a copy of the flags for this particular preconditioner.
Definition at line 784 of file petsc_precondition.h.