Eigen::SuperILU< MatrixType_ > Class Template Reference

#include <Eigen/src/SuperLUSupport/SuperLUSupport.h>

Detailed Description

template<typename MatrixType_>
class Eigen::SuperILU< MatrixType_ >

A sparse direct incomplete LU factorization and solver based on the SuperLU library.

This class allows to solve for an approximate solution of A.X = B sparse linear problems via an incomplete LU factorization using the SuperLU library. This class is aimed to be used as a preconditioner of the iterative linear solvers.

Warning

This class is only for the 4.x versions of SuperLU. The 3.x and 5.x versions are not supported.

Template Parameters

MatrixType_

the type of the sparse matrix A, it must be a SparseMatrix<>

This class follows the sparse solver concept .

See also

Sparse solver concept, class IncompleteLUT, class ConjugateGradient, class BiCGSTAB

Inheritance diagram for Eigen::SuperILU< MatrixType_ >:

Public Member Functions
void	analyzePattern (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
Public Member Functions inherited from Eigen::SuperLUBase< MatrixType_, SuperILU< MatrixType_ > >
void	analyzePattern (const MatrixType &)
void	compute (const MatrixType &matrix)
ComputationInfo	info () const
	Reports whether previous computation was successful.
superlu_options_t &	options ()
Public Member Functions inherited from Eigen::SparseSolverBase< SuperILU< MatrixType_ > >
const Solve< SuperILU< MatrixType_ >, Rhs >	solve (const MatrixBase< Rhs > &b) const
const Solve< SuperILU< MatrixType_ >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
	SparseSolverBase ()

Member Function Documentation

analyzePattern()

template<typename MatrixType_>

void Eigen::SuperILU< MatrixType_ >::analyzePattern ( const MatrixType & matrix )

inline

Performs a symbolic decomposition on the sparsity of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also

factorize()

factorize()

template<typename MatrixType>

void Eigen::SuperILU< MatrixType >::factorize

(

const MatrixType &

matrix

)

Performs a numeric decomposition of matrix

The given matrix must have the same sparsity than the matrix on which the symbolic decomposition has been performed.

See also

analyzePattern()

---

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

• /builds/libeigen/eigen/Eigen/src/SuperLUSupport/SuperLUSupport.h