Abstract class for hypre's solvers and preconditioners. More...

#include <hypre.hpp>

Inheritance diagram for mfem::HypreSolver:

Collaboration diagram for mfem::HypreSolver:

Public Types
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 Member Functions
	HypreSolver ()

	HypreSolver (const HypreParMatrix *A_)

virtual	operator HYPRE_Solver () const =0
	Typecast to HYPRE_Solver – return the solver.

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

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

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

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


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

Protected Member Functions
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
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.

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

Detailed Description

Abstract class for hypre's solvers and preconditioners.

Definition at line 1161 of file hypre.hpp.

Member Enumeration Documentation

◆ ErrorMode

enum mfem::HypreSolver::ErrorMode

How to treat errors returned by hypre function calls.

Enumerator
IGNORE_HYPRE_ERRORS	Ignore hypre errors (see e.g. HypreADS)
WARN_HYPRE_ERRORS	Issue warnings on hypre errors.
ABORT_HYPRE_ERRORS	Abort on hypre errors (default in base class)

Definition at line 1165 of file hypre.hpp.

Constructor & Destructor Documentation

◆ HypreSolver() [1/2]

mfem::HypreSolver::HypreSolver ( )

Definition at line 3948 of file hypre.cpp.

◆ HypreSolver() [2/2]

mfem::HypreSolver::HypreSolver ( const HypreParMatrix * A_ )

Definition at line 3958 of file hypre.cpp.

◆ ~HypreSolver()

mfem::HypreSolver::~HypreSolver ( )

virtual

Definition at line 4087 of file hypre.cpp.

Member Function Documentation

◆ GetMemoryClass()

virtual MemoryClass mfem::HypreSolver::GetMemoryClass ( ) const

inlinevirtual

Return the MemoryClass preferred by the Operator.

This is the MemoryClass that will be used to access the input and output vectors in the Mult() and MultTranspose() methods.

For example, classes using the mfem::forall macro for implementation can return the value returned by Device::GetMemoryClass().

The default implementation of this method in class Operator returns MemoryClass::HOST.

Reimplemented from mfem::Operator.

Definition at line 1220 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 in mfem::HypreBoomerAMG, mfem::HypreFGMRES, mfem::HypreGMRES, and mfem::HyprePCG.

Definition at line 4047 of file hypre.cpp.

◆ Mult() [2/2]

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

virtual

Solve the linear system Ax=b.

Implements mfem::Operator.

Reimplemented in mfem::HypreBoomerAMG, mfem::HypreFGMRES, mfem::HypreGMRES, and mfem::HyprePCG.

Definition at line 4080 of file hypre.cpp.

◆ operator HYPRE_Solver()

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

pure virtual

Typecast to HYPRE_Solver – return the solver.

Implemented in mfem::HypreADS, mfem::HypreAMS, mfem::HypreBoomerAMG, mfem::HypreDiagScale, mfem::HypreEuclid, mfem::HypreFGMRES, mfem::HypreGMRES, mfem::HypreIdentity, mfem::HypreILU, mfem::HypreParaSails, mfem::HyprePCG, and mfem::HypreTriSolve.

◆ SetErrorMode()

void mfem::HypreSolver::SetErrorMode ( ErrorMode err_mode ) const

inline

Set the behavior for treating hypre errors, see the ErrorMode enum. The default mode in the base class is ABORT_HYPRE_ERRORS.

Currently, there are three cases in derived classes where the error flag is set to IGNORE_HYPRE_ERRORS: in the method HypreBoomerAMG::SetElasticityOptions(), and in the constructor of classes HypreAMS and HypreADS. The reason for this is that a nonzero hypre error is returned) when hypre_ParCSRComputeL1Norms() encounters zero row in a matrix, which is expected in some cases with the above solvers.

Definition at line 1241 of file hypre.hpp.

◆ SetOperator()

virtual void mfem::HypreSolver::SetOperator ( const Operator & op )

inlinevirtual

Set/update the solver for the given operator.

Implements mfem::Solver.

Reimplemented in mfem::HypreADS, mfem::HypreAMS, mfem::HypreBoomerAMG, mfem::HypreDiagScale, mfem::HypreEuclid, mfem::HypreFGMRES, mfem::HypreGMRES, mfem::HypreILU, mfem::HypreParaSails, and mfem::HyprePCG.

Definition at line 1217 of file hypre.hpp.

◆ Setup() [1/2]

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

virtual

Set up the solver (if not set up already, also called automatically by HypreSolver::Mult).

Definition at line 4020 of file hypre.cpp.

◆ Setup() [2/2]

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

virtual

Set up the solver (if not set up already, also called automatically by HypreSolver::Mult).

Definition at line 4040 of file hypre.cpp.

◆ SetupFcn()

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

pure virtual

hypre's internal Setup function

Implemented in mfem::HypreADS, mfem::HypreAMS, mfem::HypreBoomerAMG, mfem::HypreDiagScale, mfem::HypreEuclid, mfem::HypreFGMRES, mfem::HypreGMRES, mfem::HypreIdentity, mfem::HypreILU, mfem::HypreParaSails, mfem::HyprePCG, and mfem::HypreTriSolve.

◆ SolveFcn()

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

pure virtual

hypre's internal Solve function

Implemented in mfem::HypreADS, mfem::HypreAMS, mfem::HypreBoomerAMG, mfem::HypreDiagScale, mfem::HypreEuclid, mfem::HypreFGMRES, mfem::HypreGMRES, mfem::HypreIdentity, mfem::HypreILU, mfem::HypreParaSails, mfem::HyprePCG, and mfem::HypreTriSolve.

◆ WrapVectors()

bool mfem::HypreSolver::WrapVectors	(	const Vector &	b,
		Vector &	x ) const

protected

Makes the internal HypreParVectors B and X wrap the input vectors b and x.

Returns true if x can be shallow-copied, false otherwise.

Definition at line 3969 of file hypre.cpp.

Member Data Documentation

◆ A

const HypreParMatrix* mfem::HypreSolver::A

protected

The linear system matrix.

Definition at line 1174 of file hypre.hpp.

◆ auxB

Memory<real_t> mfem::HypreSolver::auxB

mutableprotected

Definition at line 1179 of file hypre.hpp.

◆ auxX

Memory<real_t> mfem::HypreSolver::auxX

protected

Definition at line 1179 of file hypre.hpp.

◆ B

HypreParVector* mfem::HypreSolver::B

mutableprotected

Right-hand side and solution vector.

Definition at line 1177 of file hypre.hpp.

◆ error_mode

ErrorMode mfem::HypreSolver::error_mode

mutableprotected

How to treat hypre errors.

Definition at line 1185 of file hypre.hpp.

◆ setup_called

int mfem::HypreSolver::setup_called

mutableprotected

Was hypre's Setup function called already?

Definition at line 1182 of file hypre.hpp.

◆ X

HypreParVector * mfem::HypreSolver::X

protected

Definition at line 1177 of file hypre.hpp.

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

linalg/hypre.hpp
linalg/hypre.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ErrorMode

Constructor & Destructor Documentation

◆ HypreSolver() [1/2]

◆ HypreSolver() [2/2]

◆ ~HypreSolver()

Member Function Documentation

◆ GetMemoryClass()

◆ Mult() [1/2]

◆ Mult() [2/2]

◆ operator HYPRE_Solver()

◆ SetErrorMode()

◆ SetOperator()

◆ Setup() [1/2]

◆ Setup() [2/2]

◆ SetupFcn()

◆ SolveFcn()

◆ WrapVectors()

Member Data Documentation

◆ A

◆ auxB

◆ auxX

◆ B

◆ error_mode

◆ setup_called

◆ X