#include <Amesos_Umfpack.h>
Inheritance diagram for Amesos_Umfpack:
Public Member Functions | |
Amesos_Umfpack (const Epetra_LinearProblem &LinearProblem) | |
Amesos_Umfpack Constructor. | |
~Amesos_Umfpack (void) | |
Amesos_Umfpack Destructor. | |
int | SymbolicFactorization () |
Performs SymbolicFactorization on the matrix A. | |
int | NumericFactorization () |
Performs NumericFactorization on the matrix A. | |
int | Solve () |
Solves A X = B (or A^{T} x = B). | |
const Epetra_LinearProblem * | GetProblem () const |
Returns the Epetra_LinearProblem. | |
bool | MatrixShapeOK () const |
Returns true if UMFPACK can handle this matrix shape. | |
int | SetUseTranspose (bool UseTranspose_in) |
If set true, X will be set to the solution of A^{T} X = B (not A X = B). | |
bool | UseTranspose () const |
Returns the current UseTranspose setting. | |
const Epetra_Comm & | Comm () const |
Returns a pointer to the Epetra_Comm communicator associated with this operator. | |
double | GetRcond () const |
Returns an estimate of the reciprocal of the condition number. | |
int | SetParameters (Teuchos::ParameterList &ParameterList) |
Updates internal variables. | |
int | NumSymbolicFact () const |
Returns the number of symbolic factorizations performed by this object. | |
int | NumNumericFact () const |
Returns the number of numeric factorizations performed by this object. | |
int | NumSolve () const |
Returns the number of solves performed by this object. | |
void | PrintTiming () const |
Prints timing information. | |
void | PrintStatus () const |
Prints information about the factorization and solution phases. | |
void | GetTiming (Teuchos::ParameterList &TimingParameterList) const |
Extracts timing information from the current solver and places it in the parameter list. |
Amesos_Umfpack will solve a linear systems of equations: A X = B
using Epetra objects and the UMFPACK solver library, where A
is an Epetra_RowMatrix and X
and B
are Epetra_MultiVector objects.
Amesos_Umfpack::Amesos_Umfpack | ( | const Epetra_LinearProblem & | LinearProblem | ) |
Amesos_Umfpack Constructor.
Creates an Amesos_Umfpack instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object.
Note: The operator in LinearProblem must be an Epetra_RowMatrix.
Amesos_Umfpack::~Amesos_Umfpack | ( | void | ) |
Amesos_Umfpack Destructor.
Completely deletes an Amesos_Umfpack object.
const Epetra_LinearProblem* Amesos_Umfpack::GetProblem | ( | ) | const [inline, virtual] |
Returns the Epetra_LinearProblem.
Warning! Do not call return->SetOperator(...)
to attempt to change the Epetra_Operator
object (even if the new matrix has the same structure). This new operator matrix will be ignored!
Implements Amesos_BaseSolver.
bool Amesos_Umfpack::MatrixShapeOK | ( | ) | const [virtual] |
Returns true if UMFPACK can handle this matrix shape.
Returns true if the matrix shape is one that UMFPACK can handle. UMFPACK only works with square matrices.
Implements Amesos_BaseSolver.
int Amesos_Umfpack::NumericFactorization | ( | ) | [virtual] |
Performs NumericFactorization on the matrix A.
In addition to performing numeric factorization on the matrix A, the call to NumericFactorization() implies that no change will be made to the underlying matrix without a subsequent call to NumericFactorization().
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
int Amesos_Umfpack::SetParameters | ( | Teuchos::ParameterList & | ParameterList | ) | [virtual] |
Updates internal variables.
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
int Amesos_Umfpack::SetUseTranspose | ( | bool | UseTranspose_in | ) | [inline, virtual] |
If set true, X will be set to the solution of A^{T} X = B (not A X = B).
If the implementation of this interface does not support transpose use, this method should return a value of -1.
<br >Preconditions:
<br >Postconditions:
UseTranspose | -- (In) If true, solve A^{T} X = B, otherwise solve A X = B. |
Implements Amesos_BaseSolver.
int Amesos_Umfpack::Solve | ( | ) | [virtual] |
Solves A X = B (or A^{T} x = B).
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
int Amesos_Umfpack::SymbolicFactorization | ( | ) | [virtual] |
Performs SymbolicFactorization on the matrix A.
In addition to performing symbolic factorization on the matrix A, the call to SymbolicFactorization() implies that no change will be made to the non-zero structure of the underlying matrix without a subsequent call to SymbolicFactorization().
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.