MUMPS Class Reference
Last update: 16.07.2025solver for sparse matrices using MUMPS. More...
Public Types | |
| typedef number | TScalar |
| data type of matrix elements | |
| typedef Eigen::SparseMatrix< TScalar > | TSparseMatrix |
| the sparse matrix base type | |
Public Member Functions | |
| virtual bool | Compute (SparseMatrix) |
| computes the factorization, returns true if succeeded More... | |
| virtual bool | Compute (SymSparseMatrix) |
| computes the factorization, returns true if succeeded More... | |
| MUMPS (bool use_matrix_buffer_as_MUMPS_input_data=false) | |
| destructor More... | |
| MUMPS (SparseMatrix ar) | |
| constructor which already factorizes the matrix More... | |
| MUMPS (SymSparseMatrix ar) | |
| constructor which already factorizes the matrix More... | |
| virtual Matrix | operator* (Matrix other) |
| returns the matrix product inv(A)*B More... | |
| SetPositive (bool pos) | |
| Tell MUMPS if the matrix is positive definite (default: false) More... | |
| Solve (Matrix INPUT, Matrix **OUTPUT, bool **OUTPUT) | |
| Solves the given vector on return; returns true if succeeded. More... | |
| Solve (SparseMatrix INPUT, Matrix **OUTPUT, bool **OUTPUT) | |
| Solves the given sparse RHS on return; returns true if succeeded. More... | |
| virtual bool | SolveInPlace (Matrix b) |
| Factorizes this matrix and solves the given vector in place;. More... | |
| SolveTransposed (Matrix INPUT, Matrix **OUTPUT, bool **OUTPUT) | |
| Solves the system (transpose(Matrix)*x=b for x; returns true if succeeded. More... | |
| virtual string | typeIdent () |
Detailed Description
solver for sparse matrices using MUMPS.
Constructor & Destructor Documentation
◆ MUMPS() [1/3]
| MUMPS | ( | bool | use_matrix_buffer_as_MUMPS_input_data = false | ) |
destructor
default constructor (inits m_use_matrix_buffer_as_MUMPS_input_data)
- Parameters
-
use_matrix_buffer_as_MUMPS_input_data if true then the algorithm will not create internal temporary arrays used for factorization, but will act on the existing data arrays.
◆ MUMPS() [2/3]
| MUMPS | ( | SparseMatrix | ar | ) |
constructor which already factorizes the matrix
- Parameters
-
ar the matrix to be factorized
◆ MUMPS() [3/3]
| MUMPS | ( | SymSparseMatrix | ar | ) |
constructor which already factorizes the matrix
- Parameters
-
ar the matrix to be factorized
Member Function Documentation
◆ Compute() [1/2]
|
virtual |
computes the factorization, returns true if succeeded
- Parameters
-
A the matrix to be factorized
- Returns
- true of successful
Reimplemented from SparseSolver.
◆ Compute() [2/2]
|
virtual |
computes the factorization, returns true if succeeded
- Parameters
-
A the matrix to be factorized
- Returns
- true of successful
Reimplemented from SparseSolver.
◆ operator*()
returns the matrix product inv(A)*B
- Parameters
-
other the second argument of inv(A)*B
- Returns
- the product of the factorized matrix multiplied with other
◆ SetPositive()
| SetPositive | ( | bool | pos | ) |
Tell MUMPS if the matrix is positive definite (default: false)
- Parameters
-
pos true if positive definite
◆ Solve() [1/2]
Solves the given vector on return; returns true if succeeded.
- Parameters
-
b the right hand side x the solution success the return value of Solve(b,x) allow the SWIG syntax (x,bool)=Solve(b) for solving x in Ax=b in script bindings
◆ Solve() [2/2]
|
inherited |
Solves the given sparse RHS on return; returns true if succeeded.
- Parameters
-
b the right hand side x the solution
- Returns
- true if successfulallows the SWIG syntax (x,bool)=Solve(b) for solving x in Ax=b in script
◆ SolveInPlace()
|
virtual |
Factorizes this matrix and solves the given vector in place;.
- Returns
- returns true if succeeded
- Parameters
-
b on input: the right hand side. On output: the solution x
Reimplemented from SparseSolver.
◆ SolveTransposed()
Solves the system (transpose(Matrix)*x=b for x; returns true if succeeded.
- Parameters
-
b the right hand side x the solution
- Returns
- true if successful allows the SWIG syntax (x,bool)=Solve(b) for solving x in Ax=b in script.
◆ typeIdent()
|
virtualinherited |
- Returns
- the name of the datatype
