Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::PardisoLU Class Reference

A sparse direct LU factorization and solver based on the PARDISO library. More...

#include <PardisoSupport.h>

Public Member Functions

Derived & compute (const MatrixType &matrix)
 
 PardisoLU ()
 
 PardisoLU (const MatrixType &matrix)
 

Protected Types

typedef PardisoImpl< PardisoLUBase
 
typedef Base::RealScalar RealScalar
 
typedef Base::Scalar Scalar
 

Protected Member Functions

void getMatrix (const MatrixType &matrix)
 
void pardisoInit (int type)
 

Protected Attributes

SparseMatrixType m_matrix
 

Friends

class PardisoImpl< PardisoLU< MatrixType > >
 

Detailed Description

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

This class allows to solve for A.X = B sparse linear problems via a direct LU factorization using the Intel MKL PARDISO library. The sparse matrix A must be squared and invertible. The vectors or matrices X and B can be either dense or sparse.

By default, it runs in in-core mode. To enable PARDISO's out-of-core feature, set:

solver.pardisoParameterArray()[59] = 1;
Template Parameters
_MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>

\implsparsesolverconcept

See also
TutorialSparseSolverConcept, class SparseLU

Definition at line 37 of file PardisoSupport.h.

Member Typedef Documentation

◆ Base

Definition at line 387 of file PardisoSupport.h.

◆ RealScalar

Definition at line 389 of file PardisoSupport.h.

◆ Scalar

Definition at line 388 of file PardisoSupport.h.

Constructor & Destructor Documentation

◆ PardisoLU() [1/2]

Eigen::PardisoLU::PardisoLU ( )
inline

Definition at line 399 of file PardisoSupport.h.

◆ PardisoLU() [2/2]

Eigen::PardisoLU::PardisoLU ( const MatrixType matrix)
inlineexplicit

Definition at line 405 of file PardisoSupport.h.

Member Function Documentation

◆ compute()

Derived & Eigen::PardisoImpl< Derived >::compute

Definition at line 259 of file PardisoSupport.h.

◆ getMatrix()

void Eigen::PardisoLU::getMatrix ( const MatrixType matrix)
inlineprotected

Definition at line 412 of file PardisoSupport.h.

◆ pardisoInit()

void Eigen::PardisoImpl< Derived >::pardisoInit
inlineprotected

Definition at line 192 of file PardisoSupport.h.

Friends And Related Function Documentation

◆ PardisoImpl< PardisoLU< MatrixType > >

friend class PardisoImpl< PardisoLU< MatrixType > >
friend

Definition at line 392 of file PardisoSupport.h.

Member Data Documentation

◆ m_matrix

SparseMatrixType Eigen::PardisoImpl< Derived >::m_matrix
mutableprotected

Definition at line 247 of file PardisoSupport.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Wed Mar 2 2022 00:07:38