MFEM  v4.3.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
mfem::HypreBoomerAMG Class Reference

The BoomerAMG solver in hypre. More...

#include <hypre.hpp>

Inheritance diagram for mfem::HypreBoomerAMG:
[legend]
Collaboration diagram for mfem::HypreBoomerAMG:
[legend]

Public Member Functions

 HypreBoomerAMG ()
 
 HypreBoomerAMG (const HypreParMatrix &A)
 
virtual void SetOperator (const Operator &op)
 Set/update the solver for the given operator. More...
 
void SetSystemsOptions (int dim, bool order_bynodes=false)
 
void SetElasticityOptions (ParFiniteElementSpace *fespace)
 
void SetAdvectiveOptions (int distance=15, const std::string &prerelax="", const std::string &postrelax="FFC")
 
void SetStrongThresholdR (double strengthR)
 Expert option - consult hypre documentation/team. More...
 
void SetFilterThresholdR (double filterR)
 Expert option - consult hypre documentation/team. More...
 
void SetRestriction (int restrict_type)
 Expert option - consult hypre documentation/team. More...
 
void SetIsTriangular ()
 Expert option - consult hypre documentation/team. More...
 
void SetGMRESSwitchR (int gmres_switch)
 Expert option - consult hypre documentation/team. More...
 
void SetCycleNumSweeps (int prerelax, int postrelax)
 Expert option - consult hypre documentation/team. More...
 
void SetPrintLevel (int print_level)
 
void SetMaxIter (int max_iter)
 
void SetMaxLevels (int max_levels)
 Expert option - consult hypre documentation/team. More...
 
void SetTol (double tol)
 Expert option - consult hypre documentation/team. More...
 
void SetStrengthThresh (double strength)
 Expert option - consult hypre documentation/team. More...
 
void SetInterpolation (int interp_type)
 Expert option - consult hypre documentation/team. More...
 
void SetCoarsening (int coarsen_type)
 Expert option - consult hypre documentation/team. More...
 
void SetRelaxType (int relax_type)
 Expert option - consult hypre documentation/team. More...
 
void SetCycleType (int cycle_type)
 Expert option - consult hypre documentation/team. More...
 
void GetNumIterations (int &num_iterations) const
 
void SetNodal (int blocksize)
 Expert option - consult hypre documentation/team. More...
 
void SetAggressiveCoarsening (int num_levels)
 Expert option - consult hypre documentation/team. More...
 
virtual operator HYPRE_Solver () const
 The typecast to HYPRE_Solver returns the internal amg_precond. More...
 
virtual HYPRE_PtrToParSolverFcn SetupFcn () const
 hypre's internal Setup function More...
 
virtual HYPRE_PtrToParSolverFcn SolveFcn () const
 hypre's internal Solve function More...
 
virtual ~HypreBoomerAMG ()
 
- Public Member Functions inherited from mfem::HypreSolver
 HypreSolver ()
 
 HypreSolver (const HypreParMatrix *A_)
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator. More...
 
virtual void Mult (const HypreParVector &b, HypreParVector &x) const
 Solve the linear system Ax=b. More...
 
virtual void Mult (const Vector &b, Vector &x) const
 Operator application: y=A(x). More...
 
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. More...
 
virtual ~HypreSolver ()
 
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 Initialize a square Solver with size s. More...
 
 Solver (int h, int w, bool iter_mode=false)
 Initialize a Solver with height h and width w. More...
 
- 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. More...
 
 Operator (int s=0)
 Construct a square Operator with given size s (default 0). More...
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size). More...
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows(). More...
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height(). More...
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols(). More...
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width(). More...
 
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. More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
 
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. More...
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
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. More...
 
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. More...
 
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(). More...
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator. More...
 
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). More...
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator. More...
 
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 
Type GetType () const
 Return the type ID of the Operator class. More...
 

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
}
 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. More...
 
- Protected Member Functions inherited from mfem::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator() More...
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator() More...
 
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...
 
- Protected Attributes inherited from mfem::HypreSolver
const HypreParMatrixA
 The linear system matrix. More...
 
HypreParVectorB
 Right-hand side and solution vector. More...
 
HypreParVectorX
 
Memory< double > auxB
 
Memory< double > auxX
 
int setup_called
 Was hypre's Setup function called already? More...
 
ErrorMode error_mode
 How to treat hypre errors. More...
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix. More...
 
int width
 Dimension of the input / number of columns in the matrix. More...
 

Detailed Description

The BoomerAMG solver in hypre.

Definition at line 1387 of file hypre.hpp.

Constructor & Destructor Documentation

mfem::HypreBoomerAMG::HypreBoomerAMG ( )

Definition at line 4306 of file hypre.cpp.

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

Definition at line 4312 of file hypre.cpp.

mfem::HypreBoomerAMG::~HypreBoomerAMG ( )
virtual

Definition at line 4725 of file hypre.cpp.

Member Function Documentation

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

Definition at line 1501 of file hypre.hpp.

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

The typecast to HYPRE_Solver returns the internal amg_precond.

Implements mfem::HypreSolver.

Definition at line 1520 of file hypre.hpp.

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 4617 of file hypre.cpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1516 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1490 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1460 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1498 of file hypre.hpp.

void mfem::HypreBoomerAMG::SetElasticityOptions ( ParFiniteElementSpace fespace)

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. This solver assumes Ordering::byVDIM in the FiniteElementSpace used to construct A.

Definition at line 4569 of file hypre.cpp.

void mfem::HypreBoomerAMG::SetFilterThresholdR ( double  filterR)
inline

Expert option - consult hypre documentation/team.

Definition at line 1444 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1456 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1486 of file hypre.hpp.

void mfem::HypreBoomerAMG::SetIsTriangular ( )
inline

Expert option - consult hypre documentation/team.

Definition at line 1452 of file hypre.hpp.

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

Definition at line 1470 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1474 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1509 of file hypre.hpp.

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

Set/update the solver for the given operator.

Reimplemented from mfem::HypreSolver.

Definition at line 4447 of file hypre.cpp.

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

Definition at line 1467 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1494 of file hypre.hpp.

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

Expert option - consult hypre documentation/team.

Definition at line 1448 of file hypre.hpp.

void mfem::HypreBoomerAMG::SetStrengthThresh ( double  strength)
inline

Expert option - consult hypre documentation/team.

Definition at line 1482 of file hypre.hpp.

void mfem::HypreBoomerAMG::SetStrongThresholdR ( double  strengthR)
inline

Expert option - consult hypre documentation/team.

Definition at line 1440 of file hypre.hpp.

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

More robust options for systems, such as elasticity.

Definition at line 4466 of file hypre.cpp.

void mfem::HypreBoomerAMG::SetTol ( double  tol)
inline

Expert option - consult hypre documentation/team.

Definition at line 1478 of file hypre.hpp.

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

hypre's internal Setup function

Implements mfem::HypreSolver.

Definition at line 1522 of file hypre.hpp.

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

hypre's internal Solve function

Implements mfem::HypreSolver.

Definition at line 1524 of file hypre.hpp.


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