Eigen::PastixLU< _MatrixType, IsStrSym > Class Template Reference

Interface to the PaStix solver. More...

#include <PaStiXSupport.h>

Inheritance diagram for Eigen::PastixLU< _MatrixType, IsStrSym >:

Collaboration diagram for Eigen::PastixLU< _MatrixType, IsStrSym >:

Public Types
typedef _MatrixType	MatrixType
typedef PastixBase< PastixLU< MatrixType > >	Base
typedef Base::ColSpMatrix	ColSpMatrix
typedef MatrixType::Index	Index
Public Types inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
typedef internal::pastix_traits< PastixLU< _MatrixType > >::MatrixType	_MatrixType
typedef _MatrixType	MatrixType
typedef MatrixType::Scalar	Scalar
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType::Index	Index
typedef Matrix< Scalar, Dynamic, 1 >	Vector
typedef SparseMatrix< Scalar, ColMajor >	ColSpMatrix

Public Member Functions
	PastixLU (const MatrixType &matrix)
void	compute (const MatrixType &matrix)
void	analyzePattern (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
Public Member Functions inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
const internal::solve_retval< PastixBase, Rhs >	solve (const MatrixBase< Rhs > &b) const
const internal::sparse_solve_retval< PastixBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
bool	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const
PastixLU< _MatrixType > &	derived ()
const PastixLU< _MatrixType > &	derived () const
Array< Index, IPARM_SIZE, 1 > &	iparm ()
int &	iparm (int idxparam)
Array< RealScalar, IPARM_SIZE, 1 > &	dparm ()
double &	dparm (int idxparam)
Index	cols () const
Index	rows () const
ComputationInfo	info () const
	Reports whether previous computation was successful. More...

Protected Member Functions
void	init ()
void	grabMatrix (const MatrixType &matrix, ColSpMatrix &out)
Protected Member Functions inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
void	init ()
void	analyzePattern (ColSpMatrix &mat)
void	factorize (ColSpMatrix &mat)
void	clean ()
void	compute (ColSpMatrix &mat)

Protected Attributes
ColSpMatrix	m_transposedStructure
bool	m_structureIsUptodate
Protected Attributes inherited from Eigen::PastixBase< PastixLU< _MatrixType > >
int	m_initisOk
int	m_analysisIsOk
int	m_factorizationIsOk
bool	m_isInitialized
ComputationInfo	m_info
pastix_data_t *	m_pastixdata
int	m_comm
Matrix< int, IPARM_SIZE, 1 >	m_iparm
Matrix< double, DPARM_SIZE, 1 >	m_dparm
Matrix< Index, Dynamic, 1 >	m_perm
Matrix< Index, Dynamic, 1 >	m_invp
int	m_size

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

TutorialSparseDirectSolvers

Definition at line 23 of file PaStiXSupport.h.

Member Function Documentation

template<typename _MatrixType , bool IsStrSym>

void Eigen::PastixLU< _MatrixType, IsStrSym >::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()

Definition at line 467 of file PaStiXSupport.h.

    {
      m_structureIsUptodate = false;
      ColSpMatrix temp;
      grabMatrix(matrix, temp);
      Base::analyzePattern(temp);
    }

template<typename _MatrixType , bool IsStrSym>

void Eigen::PastixLU< _MatrixType, IsStrSym >::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()

Definition at line 455 of file PaStiXSupport.h.

    {
      m_structureIsUptodate = false;
      ColSpMatrix temp;
      grabMatrix(matrix, temp);
      Base::compute(temp);
    }

template<typename _MatrixType , bool IsStrSym>

void Eigen::PastixLU< _MatrixType, IsStrSym >::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()

Definition at line 480 of file PaStiXSupport.h.

    {
      ColSpMatrix temp;
      grabMatrix(matrix, temp);
      Base::factorize(temp);
    }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/PaStiXSupport/PaStiXSupport.h