Wrapper around parallel sparse direct solvers (MUMPS, SuperLU_DIST, STRUMPACK, CPARDISO). More...

#include <solver_utils.hpp>

Inheritance diagram for mfem::ParallelDirectSolver:

Collaboration diagram for mfem::ParallelDirectSolver:

Public Types
enum class	Type { AUTO , MUMPS , SUPERLU , CPARDISO , STRUMPACK }
	Type of parallel direct solver to use. 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
	ParallelDirectSolver (MPI_Comm comm_, Type type_=Type::AUTO)
	Construct a ParallelDirectSolver from an MPI communicator and a Type.

	ParallelDirectSolver (MPI_Comm comm_, const std::string &name)
	Construct a ParallelDirectSolver from a string name. Accepted strings: "auto", "mumps", "superlu", "cpardiso", "strumpack". The string is converted to a Type and the other constructor is invoked.

virtual	~ParallelDirectSolver ()

virtual void	SetOperator (const Operator &op) override
	Set the operator to be factored/solved by the direct solver.

virtual void	Mult (const Vector &x, Vector &y) const override
	Apply the inverse of the operator: y = A^{-1} x.

virtual void	SetPrintLevel (int print_lvl)

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	AbsMult (const Vector &x, Vector &y) const
	Action of the absolute-value operator: `y=\|A\|(x)`. The default behavior in class Operator is to generate an error. If the Operator is a composition of several operators, the composition unfold into a product of absolute-value operators too.

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	AbsMultTranspose (const Vector &x, Vector &y) const
	Action of the transpose absolute-value 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 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()

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

Wrapper around parallel sparse direct solvers (MUMPS, SuperLU_DIST, STRUMPACK, CPARDISO).

ParallelDirectSolver provides a uniform interface to several parallel sparse direct solvers. The solver is selected at runtime via the Type enum or a string name, while the actual availability of each backend depends on how MFEM was configured and built.

Supported backends (if enabled at configure time):

MUMPS (MFEM_USE_MUMPS)
SuperLU (MFEM_USE_SUPERLU)
STRUMPACK (MFEM_USE_STRUMPACK)
CPARDISO (MFEM_USE_MKL_CPARDISO)

The typical usage pattern is:

Construct a ParallelDirectSolver with an MPI communicator and a backend.
Call SetOperator() with the system operator (usually a HypreParMatrix).
Call Mult() to apply the inverse (i.e. solve).

Definition at line 43 of file solver_utils.hpp.

Member Enumeration Documentation

◆ Type

enum class mfem::ParallelDirectSolver::Type

strong

Type of parallel direct solver to use.

AUTO selects the first available backend at runtime according to an internal priority order.

Enumerator
AUTO
MUMPS
SUPERLU
CPARDISO
STRUMPACK

Definition at line 52 of file solver_utils.hpp.

Constructor & Destructor Documentation

◆ ParallelDirectSolver() [1/2]

mfem::ParallelDirectSolver::ParallelDirectSolver	(	MPI_Comm	comm_,
		Type	type_ = Type::AUTO )

Construct a ParallelDirectSolver from an MPI communicator and a Type.

If type_ is Type::AUTO, the constructor will select the first available backend according to an internal priority order and store the resolved type in type. No factorization is performed here; that happens when SetOperator() is called.

Definition at line 49 of file solver_utils.cpp.

◆ ParallelDirectSolver() [2/2]

mfem::ParallelDirectSolver::ParallelDirectSolver	(	MPI_Comm	comm_,
		const std::string &	name )

Construct a ParallelDirectSolver from a string name. Accepted strings: "auto", "mumps", "superlu", "cpardiso", "strumpack". The string is converted to a Type and the other constructor is invoked.

Definition at line 70 of file solver_utils.cpp.

◆ ~ParallelDirectSolver()

virtual mfem::ParallelDirectSolver::~ParallelDirectSolver ( )

inlinevirtual

Virtual destructor. The underlying solver and any auxiliary matrices (SuperLURowLocMatrix, STRUMPACKRowLocMatrix) are destroyed automatically.

Definition at line 103 of file solver_utils.hpp.

Member Function Documentation

◆ Mult()

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

overridevirtual

Apply the inverse of the operator: y = A^{-1} x.

Implements mfem::Operator.

Definition at line 168 of file solver_utils.cpp.

◆ SetOperator()

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

overridevirtual

Set the operator to be factored/solved by the direct solver.

The expected dynamic type of op depends on the chosen backend:

MUMPS / CPARDISO :
- Usually expects a HypreParMatrix (assembled parallel sparse matrix).
SUPERLU :
- A SuperLURowLocMatrix is constructed internally from op and kept in superlu_mat. The SuperLUSolver then uses this row-local representation.
STRUMPACK :
- A STRUMPACKRowLocMatrix is constructed internally from op and kept in strumpack_mat. The STRUMPACKSolver then uses this row-local representation.

Parameters

op	The operator representing the system matrix to factor.

Implements mfem::Solver.

Definition at line 131 of file solver_utils.cpp.

◆ SetPrintLevel()

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

virtual

Definition at line 174 of file solver_utils.cpp.

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

miniapps/contact/solver_utils.hpp
miniapps/contact/solver_utils.cpp

Public Types

Public Member Functions

Additional Inherited Members