PEXSI::SuperLUOptions Struct Reference

A thin interface for passing parameters to set the SuperLU options. More...

#include <superlu_dist_internal.hpp>

Public Attributes
Int	numProcSymbFact
	Number of processors for parallel symbolic factorization. More...
std::string	ColPerm
	Option of matrixi column permutation strategy. More...
std::string	RowPerm
	Option of matrix row permutation strategy. More...
std::string	Equil
	Option whether to equilibrate the system. More...
Int	Symmetric
	Option to specify if matrix is symmetric or not.
Int	Transpose
	Option to specify whether selected elements should be computed in the pattern of the transposed matrix or not. Note that this has an impact only for unsymmetric matrices.

Detailed Description

A thin interface for passing parameters to set the SuperLU options.

Member Data Documentation

std::string PEXSI::SuperLUOptions::ColPerm

Option of matrixi column permutation strategy.

The following options of column permutation strategy are available (case sensitive):

• "MMD_AT_PLUS_A": Multiple minimum degree ordering. This is the default option.
• "METIS_AT_PLUS_A": Sequential ordering using METIS. This requires the usage of METIS package.
• "PARMETIS": Parallel ordering. This requires the usage of ParMETIS/PT-SCOTCH package.
• "NATURAL": No ordering. This lead to SIGNIFICANTLY higher computational and storage costs.

std::string PEXSI::SuperLUOptions::Equil

Option whether to equilibrate the system.

The following options of equilibration strategy are available (case sensitive):

• "YES": Scale A's rows and columns to have unit norm.
• "NO": Don't equilibrate the system.

Int PEXSI::SuperLUOptions::numProcSymbFact

Number of processors for parallel symbolic factorization.

numProcSymbFact should be a power of 2, and is only useful when

ColPerm = "PARMETIS"

std::string PEXSI::SuperLUOptions::RowPerm

Option of matrix row permutation strategy.

The following options of row permutation strategy are available (case sensitive):

• "LargeDiag": Make the diagonal large relative to off-diagonal elements (MC64).
• "NOROWPERM": No row permutation. This might lead to numerically unstable factorization, and selected inversion.

---

The documentation for this struct was generated from the following file:

• include/pexsi/superlu_dist_internal.hpp