Amesos_Superludist Class Reference

Amesos_Superludist: An object-oriented wrapper for Superludist. More...

#include <Amesos_Superludist.h>

Inheritance diagram for Amesos_Superludist:

Inheritance graph
[legend]
Collaboration diagram for Amesos_Superludist:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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
 Print various timig.
void PrintStatus () const
 Print various information about the parameters used by Superludist.
void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list.
 Amesos_Superludist (const Epetra_LinearProblem &LinearProblem)
 Amesos_Superludist Constructor.
 ~Amesos_Superludist (void)
 Amesos_Superludist Destructor.
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).
int SetUseTranspose (bool UseTranspose)
 Amesos_Superludist does not support transpose at this time.
const Epetra_LinearProblemGetProblem () const
 Returns the Epetra_LinearProblem.
bool MatrixShapeOK () const
 Returns true if SUPERLUDIST can handle this matrix shape.
bool UseTranspose () const
 Always returns true.

Detailed Description

Amesos_Superludist: An object-oriented wrapper for Superludist.

Amesos_Superludist will solve a linear systems of equations: A X = B using Epetra objects and the Superludist solver library, where A is an Epetra_RowMatrix and X and B are Epetra_MultiVector objects.


Constructor & Destructor Documentation

Amesos_Superludist::Amesos_Superludist ( const Epetra_LinearProblem LinearProblem  ) 

Amesos_Superludist Constructor.

Creates an Amesos_Superludist instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object.

Note: The operator in LinearProblem must be an Epetra_RowMatrix.

Amesos_Superludist::~Amesos_Superludist ( void   ) 

Amesos_Superludist Destructor.

Completely deletes an Amesos_Superludist object.


Member Function Documentation

const Epetra_LinearProblem* Amesos_Superludist::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_Superludist::MatrixShapeOK (  )  const [virtual]

Returns true if SUPERLUDIST can handle this matrix shape.

Returns true if the matrix shape is one that SUPERLUDIST can handle. SUPERLUDIST only works with square matrices.

Implements Amesos_BaseSolver.

int Amesos_Superludist::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:

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

Implements Amesos_BaseSolver.

int Amesos_Superludist::SetParameters ( Teuchos::ParameterList ParameterList  )  [virtual]

Updates internal variables.

<br >Preconditions:

<br >Postconditions:

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

Implements Amesos_BaseSolver.

int Amesos_Superludist::SetUseTranspose ( bool  UseTranspose  )  [inline, virtual]

Amesos_Superludist does not support transpose at this time.

returns 0 if UseTranspose is set to false, else 1 (failure)

Implements Amesos_BaseSolver.

int Amesos_Superludist::Solve (  )  [virtual]

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

<br >Preconditions:

<br >Postconditions:

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

Implements Amesos_BaseSolver.

int Amesos_Superludist::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 Tue Oct 20 12:55:26 2009 for Amesos by doxygen 1.4.7