MFEM  v4.5.0
Finite element discretization library
Public Member Functions | List of all members
mfem::HypreFGMRES Class Reference

Flexible GMRES solver in hypre. More...

#include <hypre.hpp>

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

Public Member Functions

 HypreFGMRES (MPI_Comm comm)
 
 HypreFGMRES (const HypreParMatrix &A_)
 
virtual void SetOperator (const Operator &op)
 Set/update the solver for the given operator. More...
 
void SetTol (double tol)
 
void SetMaxIter (int max_iter)
 
void SetKDim (int dim)
 
void SetLogging (int logging)
 
void SetPrintLevel (int print_lvl)
 
void SetPreconditioner (HypreSolver &precond)
 Set the hypre solver to be used as a preconditioner. More...
 
MFEM_DEPRECATED void SetZeroInintialIterate ()
 deprecated: use SetZeroInitialIterate() More...
 
void SetZeroInitialIterate ()
 non-hypre setting More...
 
void GetNumIterations (int &num_iterations) const
 
void GetFinalResidualNorm (double &final_res_norm) const
 
virtual operator HYPRE_Solver () const
 The typecast to HYPRE_Solver returns the internal fgmres_solver. More...
 
virtual HYPRE_PtrToParSolverFcn SetupFcn () const
 FGMRES Setup function. More...
 
virtual HYPRE_PtrToParSolverFcn SolveFcn () const
 FGMRES Solve function. More...
 
virtual void Mult (const HypreParVector &b, HypreParVector &x) const
 Solve Ax=b with hypre's FGMRES. More...
 
virtual ~HypreFGMRES ()
 
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
 Solve the linear system Ax=b. More...
 
- Public Member Functions inherited from mfem::HypreSolver
 HypreSolver ()
 
 HypreSolver (const HypreParMatrix *A_)
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator. 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 ()
 
virtual void Setup (const HypreParVector &b, HypreParVector &x) const
 Set up the solver (if not set up already, also called automatically by HypreSolver::Mult). More...
 
virtual void Setup (const Vector &b, Vector &x) const
 Set up the solver (if not set up already, also called automatically by HypreSolver::Mult). More...
 
virtual void Mult (const Vector &b, Vector &x) const
 Solve the linear system Ax=b. More...
 
- 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, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator 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,
  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. More...
 
- 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. 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

Flexible GMRES solver in hypre.

Definition at line 1333 of file hypre.hpp.

Constructor & Destructor Documentation

◆ HypreFGMRES() [1/2]

mfem::HypreFGMRES::HypreFGMRES ( MPI_Comm  comm)

Definition at line 4298 of file hypre.cpp.

◆ HypreFGMRES() [2/2]

mfem::HypreFGMRES::HypreFGMRES ( const HypreParMatrix A_)

Definition at line 4306 of file hypre.cpp.

◆ ~HypreFGMRES()

mfem::HypreFGMRES::~HypreFGMRES ( )
virtual

Definition at line 4458 of file hypre.cpp.

Member Function Documentation

◆ GetFinalResidualNorm()

void mfem::HypreFGMRES::GetFinalResidualNorm ( double &  final_res_norm) const
inline

Definition at line 1372 of file hypre.hpp.

◆ GetNumIterations()

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

Definition at line 1365 of file hypre.hpp.

◆ Mult() [1/3]

void mfem::HypreFGMRES::Mult ( const HypreParVector b,
HypreParVector x 
) const
virtual

Solve Ax=b with hypre's FGMRES.

Reimplemented from mfem::HypreSolver.

Definition at line 4386 of file hypre.cpp.

◆ Mult() [2/3]

void mfem::HypreSolver::Mult

Solve the linear system Ax=b.

Definition at line 3906 of file hypre.cpp.

◆ Mult() [3/3]

void mfem::HypreSolver::Mult

Solve the linear system Ax=b.

Definition at line 3939 of file hypre.cpp.

◆ operator HYPRE_Solver()

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

The typecast to HYPRE_Solver returns the internal fgmres_solver.

Implements mfem::HypreSolver.

Definition at line 1379 of file hypre.hpp.

◆ SetKDim()

void mfem::HypreFGMRES::SetKDim ( int  dim)

Definition at line 4362 of file hypre.cpp.

◆ SetLogging()

void mfem::HypreFGMRES::SetLogging ( int  logging)

Definition at line 4367 of file hypre.cpp.

◆ SetMaxIter()

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

Definition at line 4357 of file hypre.cpp.

◆ SetOperator()

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

Set/update the solver for the given operator.

Reimplemented from mfem::HypreSolver.

Definition at line 4330 of file hypre.cpp.

◆ SetPreconditioner()

void mfem::HypreFGMRES::SetPreconditioner ( HypreSolver precond)

Set the hypre solver to be used as a preconditioner.

Definition at line 4377 of file hypre.cpp.

◆ SetPrintLevel()

void mfem::HypreFGMRES::SetPrintLevel ( int  print_lvl)

Definition at line 4372 of file hypre.cpp.

◆ SetTol()

void mfem::HypreFGMRES::SetTol ( double  tol)

Definition at line 4352 of file hypre.cpp.

◆ SetupFcn()

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

FGMRES Setup function.

Implements mfem::HypreSolver.

Definition at line 1382 of file hypre.hpp.

◆ SetZeroInintialIterate()

MFEM_DEPRECATED void mfem::HypreFGMRES::SetZeroInintialIterate ( )
inline

deprecated: use SetZeroInitialIterate()

Definition at line 1360 of file hypre.hpp.

◆ SetZeroInitialIterate()

void mfem::HypreFGMRES::SetZeroInitialIterate ( )
inline

non-hypre setting

Definition at line 1363 of file hypre.hpp.

◆ SolveFcn()

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

FGMRES Solve function.

Implements mfem::HypreSolver.

Definition at line 1385 of file hypre.hpp.


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