MFEM  v4.2.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
mfem::SuperLUSolver Class Reference

#include <superlu.hpp>

Inheritance diagram for mfem::SuperLUSolver:
Collaboration diagram for mfem::SuperLUSolver:

Public Member Functions

 SuperLUSolver (MPI_Comm comm)
 SuperLUSolver (SuperLURowLocMatrix &A)
 ~SuperLUSolver (void)
void SetupGrid ()
void DismantleGrid ()
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 SetPrintStatistics (bool print_stat)
void SetEquilibriate (bool equil)
void SetColumnPermutation (superlu::ColPerm col_perm)
void SetRowPermutation (superlu::RowPerm row_perm, Array< int > *perm=NULL)
void SetTranspose (superlu::Trans trans)
void SetIterativeRefine (superlu::IterRefine iter_ref)
void SetReplaceTinyPivot (bool rtp)
void SetNumLookAheads (int num_lookaheads)
void SetLookAheadElimTree (bool etree)
void SetSymmetricPattern (bool sym)
- 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 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 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 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=0, int m=0) const
 Prints operator with input size n and output size m 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_
const SuperLURowLocMatrixAPtr_
void * optionsPtr_
void * statPtr_
void * ScalePermstructPtr_
void * LUstructPtr_
void * SOLVEstructPtr_
void * gridPtr_
double * berr_
int * perm_r_
int nrhs_
int nprow_
int npcol_
bool firstSolveWithThisA_
bool gridInitialized_
bool LUStructInitialized_
- 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 {
  PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR
 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...
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, taking in input/output Prolongation matrices. More...

Detailed Description

The MFEM SuperLU Direct Solver class.

The mfem::SuperLUSolver class uses the SuperLU_DIST library to perform LU factorization of a parallel sparse matrix. The solver is capable of handling double precision types. It is currently maintained by Xiaoye Sherry Li at NERSC, see

Definition at line 88 of file superlu.hpp.

Constructor & Destructor Documentation

mfem::SuperLUSolver::SuperLUSolver ( MPI_Comm  comm)

Definition at line 205 of file superlu.cpp.

mfem::SuperLUSolver::SuperLUSolver ( SuperLURowLocMatrix A)

Definition at line 226 of file superlu.cpp.

mfem::SuperLUSolver::~SuperLUSolver ( void  )

Definition at line 250 of file superlu.cpp.

Member Function Documentation

void mfem::SuperLUSolver::DismantleGrid ( )

Definition at line 459 of file superlu.cpp.

void mfem::SuperLUSolver::Mult ( const Vector x,
Vector y 
) const

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 471 of file superlu.cpp.

void mfem::SuperLUSolver::SetColumnPermutation ( superlu::ColPerm  col_perm)

Definition at line 340 of file superlu.cpp.

void mfem::SuperLUSolver::SetEquilibriate ( bool  equil)

Definition at line 331 of file superlu.cpp.

void mfem::SuperLUSolver::SetIterativeRefine ( superlu::IterRefine  iter_ref)

Definition at line 386 of file superlu.cpp.

void mfem::SuperLUSolver::SetLookAheadElimTree ( bool  etree)

Definition at line 411 of file superlu.cpp.

void mfem::SuperLUSolver::SetNumLookAheads ( int  num_lookaheads)

Definition at line 404 of file superlu.cpp.

void mfem::SuperLUSolver::SetOperator ( const Operator op)

Set/update the solver for the given operator.

Implements mfem::Solver.

Definition at line 576 of file superlu.cpp.

void mfem::SuperLUSolver::SetPrintStatistics ( bool  print_stat)

Definition at line 322 of file superlu.cpp.

void mfem::SuperLUSolver::SetReplaceTinyPivot ( bool  rtp)

Definition at line 395 of file superlu.cpp.

void mfem::SuperLUSolver::SetRowPermutation ( superlu::RowPerm  row_perm,
Array< int > *  perm = NULL 

Definition at line 349 of file superlu.cpp.

void mfem::SuperLUSolver::SetSymmetricPattern ( bool  sym)

Definition at line 420 of file superlu.cpp.

void mfem::SuperLUSolver::SetTranspose ( superlu::Trans  trans)

Definition at line 377 of file superlu.cpp.

void mfem::SuperLUSolver::SetupGrid ( )

Definition at line 429 of file superlu.cpp.

Member Data Documentation

const SuperLURowLocMatrix* mfem::SuperLUSolver::APtr_

Definition at line 134 of file superlu.hpp.

double* mfem::SuperLUSolver::berr_

Definition at line 149 of file superlu.hpp.

MPI_Comm mfem::SuperLUSolver::comm_

Definition at line 130 of file superlu.hpp.

bool mfem::SuperLUSolver::firstSolveWithThisA_

Definition at line 154 of file superlu.hpp.

bool mfem::SuperLUSolver::gridInitialized_

Definition at line 155 of file superlu.hpp.

void* mfem::SuperLUSolver::gridPtr_

Definition at line 147 of file superlu.hpp.

bool mfem::SuperLUSolver::LUStructInitialized_

Definition at line 156 of file superlu.hpp.

void* mfem::SuperLUSolver::LUstructPtr_

Definition at line 145 of file superlu.hpp.

int mfem::SuperLUSolver::myid_

Definition at line 132 of file superlu.hpp.

int mfem::SuperLUSolver::npcol_

Definition at line 153 of file superlu.hpp.

int mfem::SuperLUSolver::nprow_

Definition at line 152 of file superlu.hpp.

int mfem::SuperLUSolver::nrhs_

Definition at line 151 of file superlu.hpp.

int mfem::SuperLUSolver::numProcs_

Definition at line 131 of file superlu.hpp.

void* mfem::SuperLUSolver::optionsPtr_

Definition at line 142 of file superlu.hpp.

int* mfem::SuperLUSolver::perm_r_

Definition at line 150 of file superlu.hpp.

void* mfem::SuperLUSolver::ScalePermstructPtr_

Definition at line 144 of file superlu.hpp.

void* mfem::SuperLUSolver::SOLVEstructPtr_

Definition at line 146 of file superlu.hpp.

void* mfem::SuperLUSolver::statPtr_

Definition at line 143 of file superlu.hpp.

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