MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::MUMPSSolver Class Reference

MUMPS: A Parallel Sparse Direct Solver. More...

#include <mumps.hpp>

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

Public Types

enum  MatType { UNSYMMETRIC = 0 , SYMMETRIC_POSITIVE_DEFINITE = 1 , SYMMETRIC_INDEFINITE = 2 }
 Specify the type of matrix we are applying the solver to. More...
 
enum  ReorderingStrategy {
  AUTOMATIC = 0 , AMD , AMF , PORD ,
  METIS , PARMETIS , SCOTCH , PTSCOTCH
}
 Specify the reordering strategy for the MUMPS solver. 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

 MUMPSSolver (MPI_Comm comm_)
 Constructor with MPI_Comm parameter.
 
 MUMPSSolver (const Operator &op)
 Constructor with a HypreParMatrix Operator.
 
void SetOperator (const Operator &op)
 Set the Operator and perform factorization.
 
void Mult (const Vector &x, Vector &y) const
 Solve \( y = Op^{-1} x \).
 
void ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Solve \( Y_i = Op^{-T} X_i \).
 
void MultTranspose (const Vector &x, Vector &y) const
 Transpose Solve \( y = Op^{-T} x \).
 
void ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Transpose Solve \( Y_i = Op^{-T} X_i \).
 
void SetPrintLevel (int print_lvl)
 Set the error print level for MUMPS.
 
void SetMatrixSymType (MatType mtype)
 Set the matrix type.
 
void SetReorderingStrategy (ReorderingStrategy method)
 Set the reordering strategy.
 
void SetReorderingReuse (bool reuse)
 Set the flag controlling reuse of the symbolic factorization for multiple operators.
 
void SetBLRTol (double tol)
 Set the tolerance for activating block low-rank (BLR) approximate factorization.
 
 ~MUMPSSolver ()
 
- 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 MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator.
 
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 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 OperatorGetGradient (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 OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity.
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.
 
virtual const OperatorGetOutputRestriction () 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 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::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()
 
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".
 
- 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

MUMPS: A Parallel Sparse Direct Solver.

Interface for the distributed MUMPS solver

Definition at line 38 of file mumps.hpp.

Member Enumeration Documentation

◆ MatType

Specify the type of matrix we are applying the solver to.

Enumerator
UNSYMMETRIC 

General sparse matrix, no symmetry is assumed.

SYMMETRIC_POSITIVE_DEFINITE 

A sparse symmetric positive definite matrix.

SYMMETRIC_INDEFINITE 

A sparse symmetric matrix that is not necessarily positive definite.

Definition at line 42 of file mumps.hpp.

◆ ReorderingStrategy

Specify the reordering strategy for the MUMPS solver.

Enumerator
AUTOMATIC 

Let MUMPS automatically decide the reording strategy.

AMD 

Approximate Minimum Degree with auto quasi-dense row detection is used.

AMF 

Approximate Minimum Fill method will be used.

PORD 

The PORD library will be used.

METIS 

The METIS library will be used.

PARMETIS 

The ParMETIS library will be used.

SCOTCH 

The Scotch library will be used.

PTSCOTCH 

The PTScotch library will be used.

Definition at line 53 of file mumps.hpp.

Constructor & Destructor Documentation

◆ MUMPSSolver() [1/2]

mfem::MUMPSSolver::MUMPSSolver ( MPI_Comm comm_)

Constructor with MPI_Comm parameter.

Definition at line 41 of file mumps.cpp.

◆ MUMPSSolver() [2/2]

mfem::MUMPSSolver::MUMPSSolver ( const Operator & op)

Constructor with a HypreParMatrix Operator.

Definition at line 46 of file mumps.cpp.

◆ ~MUMPSSolver()

mfem::MUMPSSolver::~MUMPSSolver ( )

Definition at line 79 of file mumps.cpp.

Member Function Documentation

◆ ArrayMult()

void mfem::MUMPSSolver::ArrayMult ( const Array< const Vector * > & X,
Array< Vector * > & Y ) const
virtual

Solve \( Y_i = Op^{-T} X_i \).

Parameters
XArray of RHS vectors
YArray of Solution vectors

Reimplemented from mfem::Operator.

Definition at line 362 of file mumps.cpp.

◆ ArrayMultTranspose()

void mfem::MUMPSSolver::ArrayMultTranspose ( const Array< const Vector * > & X,
Array< Vector * > & Y ) const
virtual

Transpose Solve \( Y_i = Op^{-T} X_i \).

Parameters
XArray of RHS vectors
YArray of Solution vectors

Reimplemented from mfem::Operator.

Definition at line 434 of file mumps.cpp.

◆ Mult()

void mfem::MUMPSSolver::Mult ( const Vector & x,
Vector & y ) const
virtual

Solve \( y = Op^{-1} x \).

Parameters
xRHS vector
ySolution vector

Implements mfem::Operator.

Definition at line 353 of file mumps.cpp.

◆ MultTranspose()

void mfem::MUMPSSolver::MultTranspose ( const Vector & x,
Vector & y ) const
virtual

Transpose Solve \( y = Op^{-T} x \).

Parameters
xRHS vector
ySolution vector

Reimplemented from mfem::Operator.

Definition at line 424 of file mumps.cpp.

◆ SetBLRTol()

void mfem::MUMPSSolver::SetBLRTol ( double tol)

Set the tolerance for activating block low-rank (BLR) approximate factorization.

Parameters
tolTolerance
Note
This method has to be called before SetOperator

Definition at line 466 of file mumps.cpp.

◆ SetMatrixSymType()

void mfem::MUMPSSolver::SetMatrixSymType ( MatType mtype)

Set the matrix type.

Supported matrix types: MUMPSSolver::UNSYMMETRIC, MUMPSSolver::SYMMETRIC_POSITIVE_DEFINITE, and MUMPSSolver::SYMMETRIC_INDEFINITE

Parameters
mtypeMatrix type
Note
This method has to be called before SetOperator

Definition at line 450 of file mumps.cpp.

◆ SetOperator()

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

Set the Operator and perform factorization.

op needs to be of type HypreParMatrix.

Parameters
opOperator used in factorization and solve

Implements mfem::Solver.

Definition at line 103 of file mumps.cpp.

◆ SetPrintLevel()

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

Set the error print level for MUMPS.

Supported values are:

  • 0: No output printed
  • 1: Only errors printed
  • 2: Errors, warnings, and main stats printed
  • 3: Errors, warning, main stats, and terse diagnostics printed
  • 4: Errors, warning, main stats, diagnostics, and input/output printed
Parameters
print_lvlPrint level, default is 2
Note
This method has to be called before SetOperator

Definition at line 445 of file mumps.cpp.

◆ SetReorderingReuse()

void mfem::MUMPSSolver::SetReorderingReuse ( bool reuse)

Set the flag controlling reuse of the symbolic factorization for multiple operators.

Parameters
reuseFlag to reuse symbolic factorization
Note
This method has to be called before repeated calls to SetOperator

Definition at line 460 of file mumps.cpp.

◆ SetReorderingStrategy()

void mfem::MUMPSSolver::SetReorderingStrategy ( ReorderingStrategy method)

Set the reordering strategy.

Supported reorderings are: MUMPSSolver::AUTOMATIC, MUMPSSolver::AMD, MUMPSSolver::AMF, MUMPSSolver::PORD, MUMPSSolver::METIS, MUMPSSolver::PARMETIS, MUMPSSolver::SCOTCH, and MUMPSSolver::PTSCOTCH

Parameters
methodReordering method
Note
This method has to be called before SetOperator

Definition at line 455 of file mumps.cpp.


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