Amesos_Paraklete Class Reference

Amesos_Paraklete: A serial, unblocked code ideal for getting started and for very sparse matrices, such as circuit matrces. More...

#include <Amesos_Paraklete.h>

Inheritance diagram for Amesos_Paraklete:

[legend]
Collaboration diagram for Amesos_Paraklete:
[legend]
List of all members.

Public Member Functions

Constructors and Destructors
 Amesos_Paraklete (const Epetra_LinearProblem &LinearProblem)
 Amesos_Paraklete Constructor.
 ~Amesos_Paraklete (void)
 Amesos_Paraklete Destructor.
Mathematical functions.
int SymbolicFactorization ()
 Performs SymbolicFactorization on the matrix A.
int NumericFactorization ()
 Performs NumericFactorization on the matrix A.
int Solve ()
 Solves A X = B (or AT x = B).
const Epetra_LinearProblemGetProblem () const
 Get a pointer to the Problem.
bool MatrixShapeOK () const
 Returns true if PARAKLETE can handle this matrix shape.
int SetUseTranspose (bool UseTranspose)
 SetUseTranpose().
bool UseTranspose () const
 Returns the current UseTranspose setting.
const Epetra_CommComm () 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.

Detailed Description

Amesos_Paraklete: A serial, unblocked code ideal for getting started and for very sparse matrices, such as circuit matrces.

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: $A X = B$, where A is an Epetra_RowMatrix and X and B are Epetra_MultiVector objects.

Amesos_Paraklete computes $A^T X = B$ more efficiently than $>A X = B$. 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.


Constructor & Destructor Documentation

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.


Member Function Documentation

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:

  • GetProblem().GetOperator() != 0 (return -1)
  • MatrixShapeOk(GetProblem().GetOperator()) == true (return -6)
  • The non-zero structure of the matrix should not have changed since the last call to SymbolicFactorization(). (return -2 if the number of non-zeros changes) Other changes can have arbitrary consequences.
  • The distribution of the matrix should not have changed since the last call to SymbolicFactorization()
  • The matrix should be indexed from 0 to n-1, unless the parameter "Reindex" was set to "true" prior to the call to SymbolicFactorization(). (return -3 - if caught)
  • The paremeter "Reindex" should not be set to "true" except on CrsMatrices. (return -4)
  • The paremeter "Reindex" should not be set to "true" unless Amesos was built with EpetraExt, i.e. with --enable-epetraext on the configure line. (return -4)
  • Internal errors retur -5.

<br >Postconditions:

  • Numeric Factorization will be performed (or marked to be performed) allowing Solve() to be performed correctly despite a potential change in in the matrix values (though not in the non-zero structure).

Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

int Amesos_Paraklete::SetParameters Teuchos::ParameterList ParameterList  )  [virtual]
 

Updates internal variables.

<br >Preconditions:

  • None.

<br >Postconditions:

  • Internal variables controlling the factorization and solve will be updated and take effect on all subseuent calls to NumericFactorization() and Solve().
  • All parameters whose value are to differ from the default values must be included in ParameterList. Parameters not specified in ParameterList revert to their default values.

Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

int Amesos_Paraklete::SetUseTranspose bool  UseTranspose  )  [inline, virtual]
 

SetUseTranpose().

If SetUseTranspose() is set to true, $A^T X = B$ is computed.

Implements Amesos_BaseSolver.

int Amesos_Paraklete::Solve  )  [virtual]
 

Solves A X = B (or AT x = B).

<br >Preconditions:

<br >Postconditions:

  • X will be set such that A X = B (or AT X = B), within the limits of the accuracy of the underlying solver.

Returns:
Integer error code, set to 0 if successful.

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:

Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:30:55 2008 for Amesos by doxygen 1.3.9.1