The BoomerAMG solver in hypre. More...

#include <hypre.hpp>

Inheritance diagram for mfem::HypreBoomerAMG:

Collaboration diagram for mfem::HypreBoomerAMG:

Public Member Functions
	HypreBoomerAMG ()

	HypreBoomerAMG (const HypreParMatrix &A)

virtual void	SetOperator (const Operator &op)
	Set/update the solver for the given operator.

void	SetSystemsOptions (int dim, bool order_bynodes=false)

void	SetElasticityOptions (ParFiniteElementSpace *fespace, bool interp_refine=true)

void	SetAdvectiveOptions (int distance=15, const std::string &prerelax="", const std::string &postrelax="FFC")

void	SetStrongThresholdR (real_t strengthR)
	Expert option - consult hypre documentation/team.

void	SetFilterThresholdR (real_t filterR)
	Expert option - consult hypre documentation/team.

void	SetRestriction (int restrict_type)
	Expert option - consult hypre documentation/team.

void	SetIsTriangular ()
	Expert option - consult hypre documentation/team.

void	SetGMRESSwitchR (int gmres_switch)
	Expert option - consult hypre documentation/team.

void	SetCycleNumSweeps (int prerelax, int postrelax)
	Expert option - consult hypre documentation/team.

void	SetPrintLevel (int print_level)

void	SetMaxIter (int max_iter)

void	SetMaxLevels (int max_levels)
	Expert option - consult hypre documentation/team.

void	SetTol (real_t tol)
	Expert option - consult hypre documentation/team.

void	SetStrengthThresh (real_t strength)
	Expert option - consult hypre documentation/team.

void	SetInterpolation (int interp_type)
	Expert option - consult hypre documentation/team.

void	SetCoarsening (int coarsen_type)
	Expert option - consult hypre documentation/team.

void	SetRelaxType (int relax_type)
	Expert option - consult hypre documentation/team.

void	SetCycleType (int cycle_type)
	Expert option - consult hypre documentation/team.

void	GetNumIterations (int &num_iterations) const

void	SetNodal (int blocksize)
	Expert option - consult hypre documentation/team.

void	SetAggressiveCoarsening (int num_levels)
	Expert option - consult hypre documentation/team.

virtual	operator HYPRE_Solver () const
	The typecast to HYPRE_Solver returns the internal amg_precond.

virtual HYPRE_PtrToParSolverFcn	SetupFcn () const
	hypre's internal Setup function

virtual HYPRE_PtrToParSolverFcn	SolveFcn () const
	hypre's internal Solve function

virtual	~HypreBoomerAMG ()

virtual void	Mult (const HypreParVector &b, HypreParVector &x) const
	Solve the linear system Ax=b.

virtual void	Mult (const Vector &b, Vector &x) const
	Solve the linear system Ax=b.

Public Member Functions inherited from mfem::HypreSolver
	HypreSolver ()

	HypreSolver (const HypreParMatrix *A_)

virtual MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator.

void	SetErrorMode (ErrorMode err_mode) const
	Set the behavior for treating hypre errors, see the ErrorMode enum. The default mode in the base class is ABORT_HYPRE_ERRORS.

virtual	~HypreSolver ()

virtual void	Setup (const HypreParVector &b, HypreParVector &x) const
	Set up the solver (if not set up already, also called automatically by HypreSolver::Mult).

virtual void	Setup (const Vector &b, Vector &x) const
	Set up the solver (if not set up already, also called automatically by HypreSolver::Mult).

Public Member Functions inherited from mfem::Solver
	Solver (int s=0, bool iter_mode=false)
	Initialize a square Solver with size s.

	Solver (int h, int w, bool iter_mode=false)
	Initialize a Solver with height h and width w.

Public Member Functions inherited from mfem::Operator
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system.

	Operator (int s=0)
	Construct a square Operator with given size s (default 0).

	Operator (int h, int w)
	Construct an Operator with the given height (output size) and width (input size).

int	Height () const
	Get the height (size of output) of the Operator. Synonym with NumRows().

int	NumRows () const
	Get the number of rows (size of output) of the Operator. Synonym with Height().

int	Width () const
	Get the width (size of input) of the Operator. Synonym with NumCols().

int	NumCols () const
	Get the number of columns (size of input) of the Operator. Synonym with Width().

virtual void	MultTranspose (const Vector &x, Vector &y) const
	Action of the transpose operator: `y=A^t(x)`. The default behavior in class Operator is to generate an error.

virtual void	AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`.

virtual void	AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`.

virtual void	ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Operator application on a matrix: `Y=A(X)`.

virtual void	ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`.

virtual void	ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`.

virtual void	ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`.

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.

virtual void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed.

virtual const Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity.

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity.

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

void	FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
	Form a constrained linear system using a matrix-free approach.

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-constrained linear system using a matrix-free approach.

virtual void	RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
	Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem().

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator.

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints).

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator.

void	PrintMatlab (std::ostream &out, int n, int m=0) const
	Prints operator with input size n and output size m in Matlab format.

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator in Matlab format.

virtual	~Operator ()
	Virtual destructor.

Type	GetType () const
	Return the type ID of the Operator class.

Additional Inherited Members
Public Types inherited from mfem::HypreSolver
enum	ErrorMode { IGNORE_HYPRE_ERRORS , WARN_HYPRE_ERRORS , ABORT_HYPRE_ERRORS }
	How to treat errors returned by hypre function calls. More...

Public Types inherited from mfem::Operator
enum	DiagonalPolicy { DIAG_ZERO , DIAG_ONE , DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE , MFEM_SPARSEMAT , Hypre_ParCSR , PETSC_MATAIJ , PETSC_MATIS , PETSC_MATSHELL , PETSC_MATNEST , PETSC_MATHYPRE , PETSC_MATGENERIC , Complex_Operator , MFEM_ComplexSparseMat , Complex_Hypre_ParCSR , Complex_DenseMat , MFEM_Block_Matrix , MFEM_Block_Operator }
	Enumeration defining IDs for some classes derived from Operator. More...

Public Attributes inherited from mfem::Solver
bool	iterative_mode
	If true, use the second argument of Mult() as an initial guess.

Protected Member Functions inherited from mfem::HypreSolver
bool	WrapVectors (const Vector &b, Vector &x) const
	Makes the internal HypreParVectors B and X wrap the input vectors b and x.

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator()

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator()

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt".

Protected Attributes inherited from mfem::HypreSolver
const HypreParMatrix *	A
	The linear system matrix.

HypreParVector *	B
	Right-hand side and solution vector.

HypreParVector *	X

Memory< real_t >	auxB

Memory< real_t >	auxX

int	setup_called
	Was hypre's Setup function called already?

ErrorMode	error_mode
	How to treat hypre errors.

Protected Attributes inherited from mfem::Operator
int	height
	Dimension of the output / number of rows in the matrix.

int	width
	Dimension of the input / number of columns in the matrix.

Detailed Description

The BoomerAMG solver in hypre.

Definition at line 1690 of file hypre.hpp.

Constructor & Destructor Documentation

◆ HypreBoomerAMG() [1/2]

mfem::HypreBoomerAMG::HypreBoomerAMG ( )

Definition at line 4943 of file hypre.cpp.

◆ HypreBoomerAMG() [2/2]

mfem::HypreBoomerAMG::HypreBoomerAMG ( const HypreParMatrix & A )

Definition at line 4949 of file hypre.cpp.

◆ ~HypreBoomerAMG()

mfem::HypreBoomerAMG::~HypreBoomerAMG ( )

virtual

Definition at line 5398 of file hypre.cpp.

Member Function Documentation

◆ GetNumIterations()

void mfem::HypreBoomerAMG::GetNumIterations ( int & num_iterations ) const

inline

Definition at line 1805 of file hypre.hpp.

◆ Mult() [1/2]

void mfem::HypreSolver::Mult	(	const HypreParVector &	b,
		HypreParVector &	x ) const

virtual

Solve the linear system Ax=b.

Reimplemented from mfem::HypreSolver.

Definition at line 1225 of file hypre.cpp.

◆ Mult() [2/2]

void mfem::HypreSolver::Mult	(	const Vector &	b,
		Vector &	x ) const

virtual

Solve the linear system Ax=b.

Reimplemented from mfem::HypreSolver.

Definition at line 1227 of file hypre.cpp.

◆ operator HYPRE_Solver()

virtual mfem::HypreBoomerAMG::operator HYPRE_Solver ( ) const

inlinevirtual

The typecast to HYPRE_Solver returns the internal amg_precond.

Implements mfem::HypreSolver.

Definition at line 1824 of file hypre.hpp.

◆ SetAdvectiveOptions()

void mfem::HypreBoomerAMG::SetAdvectiveOptions	(	int	distance = 15,
		const std::string &	prerelax = "",
		const std::string &	postrelax = "FFC" )

Hypre parameters to use AIR AMG solve for advection-dominated problems. See "Nonsymmetric Algebraic Multigrid Based on Local Approximate Ideal Restriction (AIR)," Manteuffel, Ruge, Southworth, SISC (2018), DOI:/10.1137/17M1144350. Options: "distanceR" -> distance of neighbor DOFs for the restriction operator; options include 1, 2, and 15 (1.5). Strings "prerelax" and "postrelax" indicate points to relax on: F = F-points, C = C-points, A = all points. E.g., FFC -> relax on F-points, relax again on F-points, then relax on C-points.

Definition at line 5290 of file hypre.cpp.

◆ SetAggressiveCoarsening()

void mfem::HypreBoomerAMG::SetAggressiveCoarsening ( int num_levels )

inline

Expert option - consult hypre documentation/team.

Definition at line 1820 of file hypre.hpp.

◆ SetCoarsening()

void mfem::HypreBoomerAMG::SetCoarsening ( int coarsen_type )

inline

Expert option - consult hypre documentation/team.

Definition at line 1794 of file hypre.hpp.

◆ SetCycleNumSweeps()

void mfem::HypreBoomerAMG::SetCycleNumSweeps	(	int	prerelax,
		int	postrelax )

inline

Expert option - consult hypre documentation/team.

Definition at line 1764 of file hypre.hpp.

◆ SetCycleType()

void mfem::HypreBoomerAMG::SetCycleType ( int cycle_type )

inline

Expert option - consult hypre documentation/team.

Definition at line 1802 of file hypre.hpp.

◆ SetElasticityOptions()

void mfem::HypreBoomerAMG::SetElasticityOptions	(	ParFiniteElementSpace *	fespace,
		bool	interp_refine = true )

A special elasticity version of BoomerAMG that takes advantage of geometric rigid body modes and could perform better on some problems, see "Improving algebraic multigrid interpolation operators for linear elasticity problems", Baker, Kolev, Yang, NLAA 2009, DOI:10.1002/nla.688. The optional argument @ interp_refine is used to enable/disable pre-processing of the interpolation matrix through iterative weight refinement

Definition at line 5238 of file hypre.cpp.

◆ SetFilterThresholdR()

void mfem::HypreBoomerAMG::SetFilterThresholdR ( real_t filterR )

inline

Expert option - consult hypre documentation/team.

Definition at line 1748 of file hypre.hpp.

◆ SetGMRESSwitchR()

void mfem::HypreBoomerAMG::SetGMRESSwitchR ( int gmres_switch )

inline

Expert option - consult hypre documentation/team.

Definition at line 1760 of file hypre.hpp.

◆ SetInterpolation()

void mfem::HypreBoomerAMG::SetInterpolation ( int interp_type )

inline

Expert option - consult hypre documentation/team.

Definition at line 1790 of file hypre.hpp.

◆ SetIsTriangular()

void mfem::HypreBoomerAMG::SetIsTriangular ( )

inline

Expert option - consult hypre documentation/team.

Definition at line 1756 of file hypre.hpp.

◆ SetMaxIter()

void mfem::HypreBoomerAMG::SetMaxIter ( int max_iter )

inline

Definition at line 1774 of file hypre.hpp.

◆ SetMaxLevels()

void mfem::HypreBoomerAMG::SetMaxLevels ( int max_levels )

inline

Expert option - consult hypre documentation/team.

Definition at line 1778 of file hypre.hpp.

◆ SetNodal()

void mfem::HypreBoomerAMG::SetNodal ( int blocksize )

inline

Expert option - consult hypre documentation/team.

Definition at line 1813 of file hypre.hpp.

◆ SetOperator()

void mfem::HypreBoomerAMG::SetOperator ( const Operator & op )

virtual

Set/update the solver for the given operator.

Reimplemented from mfem::HypreSolver.

Definition at line 5092 of file hypre.cpp.

◆ SetPrintLevel()

void mfem::HypreBoomerAMG::SetPrintLevel ( int print_level )

inline

Definition at line 1771 of file hypre.hpp.

◆ SetRelaxType()

void mfem::HypreBoomerAMG::SetRelaxType ( int relax_type )

inline

Expert option - consult hypre documentation/team.

Definition at line 1798 of file hypre.hpp.

◆ SetRestriction()

void mfem::HypreBoomerAMG::SetRestriction ( int restrict_type )

inline

Expert option - consult hypre documentation/team.

Definition at line 1752 of file hypre.hpp.

◆ SetStrengthThresh()

void mfem::HypreBoomerAMG::SetStrengthThresh ( real_t strength )

inline

Expert option - consult hypre documentation/team.

Definition at line 1786 of file hypre.hpp.

◆ SetStrongThresholdR()

void mfem::HypreBoomerAMG::SetStrongThresholdR ( real_t strengthR )

inline

Expert option - consult hypre documentation/team.

Definition at line 1744 of file hypre.hpp.

◆ SetSystemsOptions()

void mfem::HypreBoomerAMG::SetSystemsOptions	(	int	dim,
		bool	order_bynodes = false )

More robust options for systems, such as elasticity.

Definition at line 5111 of file hypre.cpp.

◆ SetTol()

void mfem::HypreBoomerAMG::SetTol ( real_t tol )

inline

Expert option - consult hypre documentation/team.

Definition at line 1782 of file hypre.hpp.

◆ SetupFcn()

virtual HYPRE_PtrToParSolverFcn mfem::HypreBoomerAMG::SetupFcn ( ) const

inlinevirtual

hypre's internal Setup function

Implements mfem::HypreSolver.

Definition at line 1826 of file hypre.hpp.

◆ SolveFcn()

virtual HYPRE_PtrToParSolverFcn mfem::HypreBoomerAMG::SolveFcn ( ) const

inlinevirtual

hypre's internal Solve function

Implements mfem::HypreSolver.

Definition at line 1828 of file hypre.hpp.

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

linalg/hypre.hpp
linalg/hypre.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HypreBoomerAMG() [1/2]

◆ HypreBoomerAMG() [2/2]

◆ ~HypreBoomerAMG()

Member Function Documentation

◆ GetNumIterations()

◆ Mult() [1/2]

◆ Mult() [2/2]

◆ operator HYPRE_Solver()

◆ SetAdvectiveOptions()

◆ SetAggressiveCoarsening()

◆ SetCoarsening()

◆ SetCycleNumSweeps()

◆ SetCycleType()

◆ SetElasticityOptions()

◆ SetFilterThresholdR()

◆ SetGMRESSwitchR()

◆ SetInterpolation()

◆ SetIsTriangular()

◆ SetMaxIter()

◆ SetMaxLevels()

◆ SetNodal()

◆ SetOperator()

◆ SetPrintLevel()

◆ SetRelaxType()

◆ SetRestriction()

◆ SetStrengthThresh()

◆ SetStrongThresholdR()

◆ SetSystemsOptions()

◆ SetTol()

◆ SetupFcn()

◆ SolveFcn()