Sparse direct LU solver based on PaStiX library. More...
#include <PaStiXSupport.h>
Public Types | |
typedef internal::pastix_traits < PastixLU< _MatrixType > >::MatrixType | _MatrixType |
typedef PastixBase< PastixLU < MatrixType > > | Base |
typedef Base::ColSpMatrix | ColSpMatrix |
typedef MatrixType::Index | Index |
typedef _MatrixType | MatrixType |
typedef MatrixType::RealScalar | RealScalar |
typedef MatrixType::Scalar | Scalar |
typedef Matrix< Scalar, Dynamic, 1 > | Vector |
Public Member Functions | |
bool | _solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &x) const |
void | _solve_sparse (const Rhs &b, SparseMatrix< DestScalar, DestOptions, DestIndex > &dest) const |
void | analyzePattern (const MatrixType &matrix) |
Index | cols () const |
void | compute (const MatrixType &matrix) |
PastixLU< _MatrixType > & | derived () |
const PastixLU< _MatrixType > & | derived () const |
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) |
PastixLU () | |
PastixLU (const MatrixType &matrix) | |
Index | rows () const |
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 |
Protected Member Functions | |
void | analyzePattern (ColSpMatrix &mat) |
void | clean () |
void | compute (ColSpMatrix &mat) |
void | factorize (ColSpMatrix &mat) |
void | grabMatrix (const MatrixType &matrix, ColSpMatrix &out) |
void | init () |
Protected Attributes | |
int | m_analysisIsOk |
int | m_comm |
Matrix< double, DPARM_SIZE, 1 > | m_dparm |
int | m_factorizationIsOk |
ComputationInfo | m_info |
int | m_initisOk |
Matrix< Index, Dynamic, 1 > | m_invp |
Matrix< int, IPARM_SIZE, 1 > | m_iparm |
bool | m_isInitialized |
pastix_data_t * | m_pastixdata |
Matrix< Index, Dynamic, 1 > | m_perm |
int | m_size |
bool | m_structureIsUptodate |
ColSpMatrix | m_transposedStructure |
Sparse direct LU solver based on PaStiX library.
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.
_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 |
|
inherited |
typedef PastixBase<PastixLU<MatrixType> > Base |
typedef Base::ColSpMatrix ColSpMatrix |
typedef MatrixType::Index Index |
typedef _MatrixType MatrixType |
|
inherited |
|
inherited |
|
inline |
References PastixLU< _MatrixType, IsStrSym >::init().
|
inline |
|
inherited |
|
inlineinherited |
References PastixBase< Derived >::derived(), eigen_assert, DenseBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::leftCols(), PastixBase< Derived >::m_factorizationIsOk, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >::middleCols(), and PastixBase< Derived >::rows().
|
protectedinherited |
|
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
References PastixBase< Derived >::analyzePattern(), PastixLU< _MatrixType, IsStrSym >::grabMatrix(), and PastixLU< _MatrixType, IsStrSym >::m_structureIsUptodate.
|
inlineprotectedinherited |
|
inlineinherited |
References PastixBase< Derived >::m_size.
|
protectedinherited |
|
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
References PastixBase< Derived >::compute(), PastixLU< _MatrixType, IsStrSym >::grabMatrix(), and PastixLU< _MatrixType, IsStrSym >::m_structureIsUptodate.
Referenced by PastixLU< _MatrixType, IsStrSym >::PastixLU().
|
inlineinherited |
|
inlineinherited |
|
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
References PastixBase< Derived >::m_dparm.
|
inlineinherited |
Return a reference to a particular index parameter of the DPARM vector
References PastixBase< Derived >::m_dparm.
|
protectedinherited |
|
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.
References PastixBase< Derived >::factorize(), and PastixLU< _MatrixType, IsStrSym >::grabMatrix().
|
inlineprotected |
References Eigen::internal::c_to_fortran_numbering(), PastixLU< _MatrixType, IsStrSym >::m_structureIsUptodate, PastixLU< _MatrixType, IsStrSym >::m_transposedStructure, SparseMatrix< _Scalar, _Options, _Index >::outerSize(), and SparseMatrixBase< Derived >::transpose().
Referenced by PastixLU< _MatrixType, IsStrSym >::analyzePattern(), PastixLU< _MatrixType, IsStrSym >::compute(), and PastixLU< _MatrixType, IsStrSym >::factorize().
|
inlineinherited |
Reports whether previous computation was successful.
Success
if computation was succesful, NumericalIssue
if the PaStiX reports a problem InvalidInput
if the input matrix is invalidReferences eigen_assert, PastixBase< Derived >::m_info, and PastixBase< Derived >::m_isInitialized.
|
inlineprotected |
Reimplemented from PastixBase< PastixLU< _MatrixType > >.
References PastixBase< PastixLU< _MatrixType > >::m_iparm, and PastixLU< _MatrixType, IsStrSym >::m_structureIsUptodate.
Referenced by PastixLU< _MatrixType, IsStrSym >::PastixLU().
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
References PastixBase< Derived >::m_iparm.
Return a reference to a particular index parameter of the IPARM vector
References PastixBase< Derived >::m_iparm.
|
inlineinherited |
References PastixBase< Derived >::m_size.
|
inlineinherited |
References eigen_assert, PastixBase< Derived >::m_isInitialized, and PastixBase< Derived >::rows().
|
inlineinherited |
References EigenBase< Derived >::derived(), eigen_assert, PastixBase< Derived >::m_isInitialized, SparseMatrixBase< Derived >::rows(), and PastixBase< Derived >::rows().
|
protectedinherited |
|
mutableprotectedinherited |
|
mutableprotectedinherited |
|
protectedinherited |
|
mutableprotectedinherited |
|
protectedinherited |
Referenced by PastixLU< _MatrixType, IsStrSym >::init().
|
protectedinherited |
|
mutableprotectedinherited |
|
mutableprotectedinherited |
|
protected |
|
protected |
Referenced by PastixLU< _MatrixType, IsStrSym >::grabMatrix().