All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Opm::LinearSolverUmfpack Class Reference

Concrete class encapsulating the UMFPACK direct linear solver. More...

#include <LinearSolverUmfpack.hpp>

Inheritance diagram for Opm::LinearSolverUmfpack:
Opm::LinearSolverInterface

Public Member Functions

 LinearSolverUmfpack ()
 Default constructor.
 
virtual ~LinearSolverUmfpack ()
 Destructor.
 
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
 Solve a linear system, with a matrix given in compressed sparse row format. More...
 
virtual void setTolerance (const double)
 Set tolerance for the linear solver. More...
 
virtual double getTolerance () const
 Get tolerance for the linear solver. More...
 
- Public Member Functions inherited from Opm::LinearSolverInterface
virtual ~LinearSolverInterface ()
 Virtual destructor.
 
LinearSolverReport solve (const CSRMatrix *A, const double *rhs, double *solution) const
 Solve a linear system, with a matrix given in compressed sparse row format. More...
 

Detailed Description

Concrete class encapsulating the UMFPACK direct linear solver.

Member Function Documentation

double Opm::LinearSolverUmfpack::getTolerance ( ) const
virtual

Get tolerance for the linear solver.

Parameters
[out]tolerancevalue Not used for UMFPACK solver. Returns -1.

Implements Opm::LinearSolverInterface.

void Opm::LinearSolverUmfpack::setTolerance ( const double  )
virtual

Set tolerance for the linear solver.

Parameters
[in]toltolerance value Not used for UMFPACK solver.

Implements Opm::LinearSolverInterface.

LinearSolverInterface::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]iaarray of length (size + 1) containing start and end indices for each row
[in]jaarray of length nonzeros containing column numbers for the nonzero elements
[in]saarray of length nonzeros containing the values of the nonzero elements
[in]rhsarray of length size containing the right hand side
[in,out]solutionarray 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 files: