Concrete class encapsulating the UMFPACK direct linear solver.
More...
#include <LinearSolverUmfpack.hpp>
|
| LinearSolverUmfpack () |
| Default constructor. More...
|
|
virtual | ~LinearSolverUmfpack () |
| Destructor. More...
|
|
virtual LinearSolverReport | solve (const int size, const int nonzeros, const int *ia, const int *ja, const double *sa, const double *rhs, double *solution, const boost::any &add=boost::any()) const |
|
virtual void | setTolerance (const double) |
|
virtual double | getTolerance () const |
|
LinearSolverReport | solve (const CSRMatrix *A, const double *rhs, double *solution) const |
|
virtual LinearSolverReport | solve (const int size, const int nonzeros, const int *ia, const int *ja, const double *sa, const double *rhs, double *solution, const boost::any &add=boost::any()) const=0 |
|
Concrete class encapsulating the UMFPACK direct linear solver.
◆ LinearSolverUmfpack()
Opm::LinearSolverUmfpack::LinearSolverUmfpack |
( |
| ) |
|
◆ ~LinearSolverUmfpack()
virtual Opm::LinearSolverUmfpack::~LinearSolverUmfpack |
( |
| ) |
|
|
virtual |
◆ getTolerance()
virtual double Opm::LinearSolverUmfpack::getTolerance |
( |
| ) |
const |
|
virtual |
Get tolerance for the linear solver. - Parameters
-
[out] | tolerance | value Not used for UMFPACK solver. Returns -1. |
Implements Opm::LinearSolverInterface.
◆ setTolerance()
virtual void Opm::LinearSolverUmfpack::setTolerance |
( |
const double |
| ) |
|
|
virtual |
Set tolerance for the linear solver. - Parameters
-
[in] | tol | tolerance value Not used for UMFPACK solver. |
Implements Opm::LinearSolverInterface.
◆ solve() [1/3]
Solve a linear system, with a matrix given in compressed sparse row format. - Parameters
-
[in] | A | matrix in CSR format |
[in] | rhs | array of length A->m containing the right hand side |
[in,out] | solution | array of length A->m to which the solution will be written, may also be used as initial guess by iterative solvers. Note: this method is a convenience method that calls the virtual solve() method. |
◆ solve() [2/3]
virtual LinearSolverReport Opm::LinearSolverUmfpack::solve |
( |
const int |
size, |
|
|
const int |
nonzeros, |
|
|
const int * |
ia, |
|
|
const int * |
ja, |
|
|
const double * |
sa, |
|
|
const double * |
rhs, |
|
|
double * |
solution, |
|
|
const boost::any & |
add = boost::any() |
|
) |
| const |
|
virtual |
Solve a linear system, with a matrix given in compressed sparse row format. - Parameters
-
[in] | size | # of rows in matrix |
[in] | nonzeros | # of nonzeros elements in matrix |
[in] | ia | array of length (size + 1) containing start and end indices for each row |
[in] | ja | array of length nonzeros containing column numbers for the nonzero elements |
[in] | sa | array of length nonzeros containing the values of the nonzero elements |
[in] | rhs | array of length size containing the right hand side |
[in,out] | solution | array of length size to which the solution will be written, may also be used as initial guess by iterative solvers. |
Implements Opm::LinearSolverInterface.
◆ solve() [3/3]
virtual LinearSolverReport Opm::LinearSolverInterface::solve |
( |
const int |
size, |
|
|
const int |
nonzeros, |
|
|
const int * |
ia, |
|
|
const int * |
ja, |
|
|
const double * |
sa, |
|
|
const double * |
rhs, |
|
|
double * |
solution, |
|
|
const boost::any & |
add = boost::any() |
|
) |
| const |
|
virtual |
Solve a linear system, with a matrix given in compressed sparse row format. - Parameters
-
[in] | size | # of rows in matrix |
[in] | nonzeros | # of nonzeros elements in matrix |
[in] | ia | array of length (size + 1) containing start and end indices for each row |
[in] | ja | array of length nonzeros containing column numbers for the nonzero elements |
[in] | sa | array of length nonzeros containing the values of the nonzero elements |
[in] | rhs | array of length size containing the right hand side |
[in,out] | solution | array of length size to which the solution will be written, may also be used as initial guess by iterative solvers. |
Implements Opm::LinearSolverInterface.
The documentation for this class was generated from the following file:
|