PastixLU< _MatrixType, IsStrSym > Class Template Reference

Interface to the PaStix solver. More...

#include <PaStiXSupport.h>

Public Member Functions
void	analyzePattern (const MatrixType &matrix)

void	compute (const MatrixType &matrix)

Array< RealScalar, IPARM_SIZE, 1 > &	dparm ()

double &	dparm (int idxparam)

void	factorize (const MatrixType &matrix)

ComputationInfo	info () const
	Reports whether previous computation was successful.

Array< Index, IPARM_SIZE, 1 > &	iparm ()

int &	iparm (int idxparam)

template<typename Rhs>
const internal::solve_retval< PastixBase, Rhs >	solve (const MatrixBase< Rhs > &b) const

template<typename Rhs>
const internal::sparse_solve_retval< PastixBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

Detailed Description

template<typename _MatrixType, bool IsStrSym>
class Eigen::PastixLU< _MatrixType, IsStrSym >

Interface to the PaStix solver.

Sparse direct LU solver based on PaStiX library.

This class is used to solve the linear systems A.X = B via the PaStix library. The matrix can be either real or complex, symmetric or not.

See also: TutorialSparseDirectSolvers

This class is used to solve the linear systems A.X = B with a supernodal LU factorization in the PaStiX library. The matrix A should be squared and nonsingular PaStiX requires that the matrix A has a symmetric structural pattern. This interface can symmetrize the input matrix otherwise. The vectors or matrices X and B can be either dense or sparse.

Template Parameters

_MatrixType	the type of the sparse matrix A, it must be a SparseMatrix<>
IsStrSym	Indicates if the input matrix has a symmetric pattern, default is false NOTE : Note that if the analysis and factorization phase are called separately, the input matrix will be symmetrized at each call, hence it is advised to symmetrize the matrix in a end-user program and set `IsStrSym` to true

See also: Solving linear problems

Member Function Documentation

◆ analyzePattern()

template<typename _MatrixType, bool IsStrSym>

void analyzePattern ( const MatrixType & matrix )

inline

Compute the LU symbolic factorization of matrix using its sparsity pattern. Several ordering methods can be used at this step. See the PaStiX user's manual. The result of this operation can be used with successive matrices having the same pattern as matrix

See also: factorize()

◆ compute()

template<typename _MatrixType, bool IsStrSym>

void compute ( const MatrixType & matrix )

inline

Compute the LU supernodal factorization of matrix. iparm and dparm can be used to tune the PaStiX parameters. see the PaStiX user's manual

See also: analyzePattern() factorize()

◆ dparm() [1/2]

template<class Derived>

Array< RealScalar, IPARM_SIZE, 1 > & dparm ( )

inlineinherited

Returns a reference to the double vector DPARM of PaStiX parameters The statistics related to the different phases of factorization and solve are saved here as well

See also: analyzePattern() factorize()

◆ dparm() [2/2]

template<class Derived>

double & dparm ( int idxparam )

inlineinherited

Return a reference to a particular index parameter of the DPARM vector

See also: dparm()

◆ factorize()

template<typename _MatrixType, bool IsStrSym>

void factorize ( const MatrixType & matrix )

inline

Compute the LU supernodal factorization of matrix WARNING The matrix matrix should have the same structural pattern as the same used in the analysis phase.

See also: analyzePattern()

◆ info()

template<class Derived>

ComputationInfo info ( ) const

inlineinherited

Reports whether previous computation was successful.

Returns: Success if computation was succesful, NumericalIssue if the PaStiX reports a problem InvalidInput if the input matrix is invalid

See also: iparm()

◆ iparm() [1/2]

template<class Derived>

Array< Index, IPARM_SIZE, 1 > & iparm ( )

inlineinherited

Returns a reference to the integer vector IPARM of PaStiX parameters to modify the default parameters. The statistics related to the different phases of factorization and solve are saved here as well