PETScWrappers::PreconditionBoomerAMG Class Reference

#include <petsc_precondition.h>

Inheritance diagram for PETScWrappers::PreconditionBoomerAMG:

Classes
struct	AdditionalData

Public Member Functions
	PreconditionBoomerAMG ()
	PreconditionBoomerAMG (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	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 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.

Author

Timo Heister, 2010

Definition at line 726 of file petsc_precondition.h.

Constructor & Destructor Documentation

PETScWrappers::PreconditionBoomerAMG::PreconditionBoomerAMG

(

)

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.

Member Function Documentation

void PETScWrappers::PreconditionBoomerAMG::initialize	(	const MatrixBase &	matrix,
		const AdditionalData &	additional_data = AdditionalData()
	)

Initializes 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.

Member Data Documentation

AdditionalData PETScWrappers::PreconditionBoomerAMG::additional_data

protected

Store a copy of the flags for this particular preconditioner.

Definition at line 847 of file petsc_precondition.h.

---

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

• include/deal.II/lac/petsc_precondition.h