MFEM  v4.6.0
Finite element discretization library
Public Types | Public Member Functions | List of all members
mfem::CPardisoSolver Class Reference

MKL Parallel Direct Sparse Solver for Clusters. More...

#include <cpardiso.hpp>

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

Public Types

enum  MatType { REAL_STRUCTURE_SYMMETRIC = 1, REAL_NONSYMMETRIC = 11 }
 
- 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

 CPardisoSolver (MPI_Comm comm)
 Construct a new CPardisoSolver object. More...
 
void SetOperator (const Operator &op) override
 Set the Operator object and perform factorization. More...
 
void Mult (const Vector &b, Vector &x) const override
 Solve. More...
 
void SetPrintLevel (int print_lvl)
 Set the print level for MKL CPardiso. More...
 
void SetMatrixType (MatType mat_type)
 Set the matrix type. More...
 
 ~CPardisoSolver ()
 
- 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 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 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 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 OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. 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, 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...
 

Additional Inherited Members

- 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, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...
 
- 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...
 

Detailed Description

MKL Parallel Direct Sparse Solver for Clusters.

Interface to MKL CPardiso: the MPI-enabled Intel MKL version of Pardiso

Definition at line 30 of file cpardiso.hpp.

Member Enumeration Documentation

◆ MatType

Enumerator
REAL_STRUCTURE_SYMMETRIC 
REAL_NONSYMMETRIC 

Definition at line 33 of file cpardiso.hpp.

Constructor & Destructor Documentation

◆ CPardisoSolver()

mfem::CPardisoSolver::CPardisoSolver ( MPI_Comm  comm)

Construct a new CPardisoSolver object.

Parameters
commMPI Communicator

Definition at line 12 of file cpardiso.cpp.

◆ ~CPardisoSolver()

mfem::CPardisoSolver::~CPardisoSolver ( )

Definition at line 197 of file cpardiso.cpp.

Member Function Documentation

◆ Mult()

void mfem::CPardisoSolver::Mult ( const Vector b,
Vector x 
) const
overridevirtual

Solve.

Parameters
bRHS vector
xSolution vector

Implements mfem::Operator.

Definition at line 162 of file cpardiso.cpp.

◆ SetMatrixType()

void mfem::CPardisoSolver::SetMatrixType ( MatType  mat_type)

Set the matrix type.

The matrix type supported is either real and symmetric or real and non-symmetric.

Parameters
mat_typeMatrix type

Definition at line 192 of file cpardiso.cpp.

◆ SetOperator()

void mfem::CPardisoSolver::SetOperator ( const Operator op)
overridevirtual

Set the Operator object and perform factorization.

op needs to be of type HypreParMatrix. The contents are copied and reordered in an internal CSR structure.

Parameters
opOperator to use in factorization and solve

Implements mfem::Solver.

Definition at line 49 of file cpardiso.cpp.

◆ SetPrintLevel()

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

Set the print level for MKL CPardiso.

Prints statistics after the factorization and after each solve.

Parameters
print_lvlPrint level

Definition at line 187 of file cpardiso.cpp.


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