#include <strumpack.hpp>

Inheritance diagram for mfem::STRUMPACKSolver:

Collaboration diagram for mfem::STRUMPACKSolver:

Public Member Functions
	STRUMPACKSolver (int argc, char *argv[], MPI_Comm comm)

	STRUMPACKSolver (STRUMPACKRowLocMatrix &A)

	~STRUMPACKSolver (void)

void	Mult (const Vector &x, Vector &y) const
	Operator application: `y=A(x)`. More...

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

void	SetFromCommandLine ()

void	SetPrintFactorStatistics (bool print_stat)

void	SetPrintSolveStatistics (bool print_stat)

void	SetRelTol (double rtol)

void	SetAbsTol (double atol)

void	SetKrylovSolver (strumpack::KrylovSolver method)

void	SetReorderingStrategy (strumpack::ReorderingStrategy method)

void	DisableMatching ()

void	EnableMatching ()

void	EnableParallelMatching ()

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 MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. 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 void	AddMult (const Vector &x, Vector &y, const double a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`. More...

virtual void	AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`. More...

virtual void	ArrayMult (const Array< const Vector > &X, Array< Vector > &Y) const
	Operator application on a matrix: `Y=A(X)`. More...

virtual void	ArrayMultTranspose (const Array< const Vector > &X, Array< Vector > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`. More...

virtual void	ArrayAddMult (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`. More...

virtual void	ArrayAddMultTranspose (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`. More...

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. 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 Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...

virtual const Operator *	GetOutputRestriction () 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...

Protected Attributes
MPI_Comm	comm_

int	numProcs_

int	myid_

bool	factor_verbose_

bool	solve_verbose_

const STRUMPACKRowLocMatrix *	APtr_

strumpack::StrumpackSparseSolverMPIDist< double, int > *	solver_

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

Additional Inherited Members
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::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...

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". More...

Detailed Description

The MFEM STRUMPACK Direct Solver class.

The mfem::STRUMPACKSolver class uses the STRUMPACK library to perform LU factorization of a parallel sparse matrix. The solver is capable of handling double precision types. See http://portal.nersc.gov/project/sparse/strumpack

Definition at line 69 of file strumpack.hpp.

Constructor & Destructor Documentation

◆ STRUMPACKSolver() [1/2]

mfem::STRUMPACKSolver::STRUMPACKSolver	(	int	argc,
		char *	argv[],
		MPI_Comm	comm
	)

Definition at line 95 of file strumpack.cpp.

◆ STRUMPACKSolver() [2/2]

mfem::STRUMPACKSolver::STRUMPACKSolver ( STRUMPACKRowLocMatrix & A )

Definition at line 103 of file strumpack.cpp.

◆ ~STRUMPACKSolver()

mfem::STRUMPACKSolver::~STRUMPACKSolver ( void )

Definition at line 114 of file strumpack.cpp.

Member Function Documentation

◆ DisableMatching()

void mfem::STRUMPACKSolver::DisableMatching ( )

Disable static pivoting for stability. The static pivoting in strumpack permutes the sparse input matrix in order to get large (nonzero) elements on the diagonal. If the input matrix is already diagonally dominant, this reordering can be disabled.

Definition at line 157 of file strumpack.cpp.

◆ EnableMatching()

void mfem::STRUMPACKSolver::EnableMatching ( )

Enable static pivoting for stability using the MC64 algorithm with job=5. Using a matching algorithm, this will permute the sparse input matrix in order to get nonzero elements (as large as possible) on the diagonal. And will also scale the rows and columns of the matrix.

Definition at line 166 of file strumpack.cpp.

◆ EnableParallelMatching()

void mfem::STRUMPACKSolver::EnableParallelMatching ( )

Use the AWPM (approximate weight perfect matching) algorithm from the Combinatorial BLAS library for static pivoting, i.e. getting large nonzeros on the diagonal. This requires that strumpack was compiled with support for Combinatorial BLAS.

Definition at line 178 of file strumpack.cpp.

◆ Mult()

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

virtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 196 of file strumpack.cpp.

◆ SetAbsTol()

void mfem::STRUMPACKSolver::SetAbsTol ( double atol )

Definition at line 190 of file strumpack.cpp.

◆ SetFromCommandLine()

void mfem::STRUMPACKSolver::SetFromCommandLine ( )

Definition at line 131 of file strumpack.cpp.

◆ SetKrylovSolver()

void mfem::STRUMPACKSolver::SetKrylovSolver ( strumpack::KrylovSolver method )

STRUMPACK is an (approximate) direct solver. It can be used as a direct solver or as a preconditioner. To use STRUMPACK as only a preconditioner, set the Krylov solver to DIRECT. STRUMPACK also provides iterative solvers which can use the preconditioner, and these iterative solvers can also be used without preconditioner.

Supported values are: AUTO: Use iterative refinement if no HSS compression is used, otherwise use GMRes. DIRECT: No outer iterative solver, just a single application of the multifrontal solver. REFINE: Iterative refinement. PREC_GMRES: Preconditioned GMRes. The preconditioner is the (approx) multifrontal solver. GMRES: UN-preconditioned GMRes. (for testing mainly) PREC_BICGSTAB: Preconditioned BiCGStab. The preconditioner is the (approx) multifrontal solver. BICGSTAB: UN-preconditioned BiCGStab. (for testing mainly)

Definition at line 146 of file strumpack.cpp.

◆ SetOperator()

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

virtual

Set/update the solver for the given operator.

Implements mfem::Solver.

Definition at line 234 of file strumpack.cpp.

◆ SetPrintFactorStatistics()

void mfem::STRUMPACKSolver::SetPrintFactorStatistics ( bool print_stat )

Definition at line 136 of file strumpack.cpp.

◆ SetPrintSolveStatistics()

void mfem::STRUMPACKSolver::SetPrintSolveStatistics ( bool print_stat )

Definition at line 141 of file strumpack.cpp.

◆ SetRelTol()

void mfem::STRUMPACKSolver::SetRelTol ( double rtol )

Definition at line 185 of file strumpack.cpp.

◆ SetReorderingStrategy()

void mfem::STRUMPACKSolver::SetReorderingStrategy ( strumpack::ReorderingStrategy method )

Supported reorderings are: METIS, PARMETIS, SCOTCH, PTSCOTCH, RCM

Definition at line 151 of file strumpack.cpp.

Member Data Documentation

◆ APtr_

const STRUMPACKRowLocMatrix* mfem::STRUMPACKSolver::APtr_

protected

Definition at line 161 of file strumpack.hpp.

◆ comm_

MPI_Comm mfem::STRUMPACKSolver::comm_

protected

Definition at line 154 of file strumpack.hpp.

◆ factor_verbose_

bool mfem::STRUMPACKSolver::factor_verbose_

protected

Definition at line 158 of file strumpack.hpp.

◆ myid_

int mfem::STRUMPACKSolver::myid_

protected

Definition at line 156 of file strumpack.hpp.

◆ numProcs_

int mfem::STRUMPACKSolver::numProcs_

protected

Definition at line 155 of file strumpack.hpp.

◆ solve_verbose_

bool mfem::STRUMPACKSolver::solve_verbose_

protected

Definition at line 159 of file strumpack.hpp.

◆ solver_

strumpack::StrumpackSparseSolverMPIDist<double,int>* mfem::STRUMPACKSolver::solver_

protected

Definition at line 162 of file strumpack.hpp.

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

linalg/strumpack.hpp
linalg/strumpack.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ STRUMPACKSolver() [1/2]

◆ STRUMPACKSolver() [2/2]

◆ ~STRUMPACKSolver()

Member Function Documentation

◆ DisableMatching()

◆ EnableMatching()

◆ EnableParallelMatching()

◆ Mult()

◆ SetAbsTol()

◆ SetFromCommandLine()

◆ SetKrylovSolver()

◆ SetOperator()

◆ SetPrintFactorStatistics()

◆ SetPrintSolveStatistics()

◆ SetRelTol()

◆ SetReorderingStrategy()

Member Data Documentation

◆ APtr_

◆ comm_

◆ factor_verbose_

◆ myid_

◆ numProcs_

◆ solve_verbose_

◆ solver_