#include <Amesos_Paraklete.h>
Inheritance diagram for Amesos_Paraklete:
Public Member Functions | |
Amesos_Paraklete (const Epetra_LinearProblem &LinearProblem) | |
Amesos_Paraklete Constructor. | |
~Amesos_Paraklete (void) | |
Amesos_Paraklete 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 |
Get a pointer to the Problem. | |
bool | MatrixShapeOK () const |
Returns true if PARAKLETE can handle this matrix shape. | |
int | SetUseTranspose (bool UseTranspose_in) |
SetUseTranpose(). | |
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. | |
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. |
Class Amesos_Paraklete is an object-oriented wrapper for PARAKLETE. PARAKLETE, whose sources are distributed within Amesos, is a serial solver for sparse matrices. PARAKLETE will solve a linear system of equations: , where A
is an Epetra_RowMatrix and X
and B
are Epetra_MultiVector objects.
Amesos_Paraklete computes more efficiently than . The latter requires a matrix transpose -- which costs both time and space.
Paraklete is Tim Davis' parallel version of KLU a low overhead non-blocked code which solves very sparse matrices fast.
Amesos_Paraklete::Amesos_Paraklete | ( | const Epetra_LinearProblem & | LinearProblem | ) |
Amesos_Paraklete Constructor.
Creates an Amesos_Paraklete instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object.
Note: The operator in LinearProblem must be an Epetra_RowMatrix.
bool Amesos_Paraklete::MatrixShapeOK | ( | ) | const [virtual] |
Returns true if PARAKLETE can handle this matrix shape.
Returns true if the matrix shape is one that PARAKLETE can handle. PARAKLETE only works with square matrices.
Implements Amesos_BaseSolver.
int Amesos_Paraklete::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_Paraklete::SetParameters | ( | Teuchos::ParameterList & | ParameterList | ) | [virtual] |
Updates internal variables.
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
int Amesos_Paraklete::SetUseTranspose | ( | bool | UseTranspose_in | ) | [inline, virtual] |
int Amesos_Paraklete::Solve | ( | ) | [virtual] |
Solves A X = B (or A^{T} x = B).
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
int Amesos_Paraklete::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.