Amesos_Superlu Class Reference

Amesos_Superlu: Amesos interface to Xioye Li's SuperLU 3.0 serial code. More...

#include <Amesos_Superlu.h>

Inheritance diagram for Amesos_Superlu:

Inheritance graph
[legend]
Collaboration diagram for Amesos_Superlu:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Amesos_Superlu (const Epetra_LinearProblem &LinearProblem)
 Amesos_Superlu Constructor.
 ~Amesos_Superlu ()
 Amesos_Superlu 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).
const Epetra_LinearProblemGetProblem () const
 Returns the Epetra_LinearProblem.
bool MatrixShapeOK () const
 Returns true if the solver can handle this matrix shape.
int SetUseTranspose (bool UseTranspose)
 If set true, X will be set to the solution of AT X = B (not A X = B).
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 status information.
void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list.

Detailed Description

Amesos_Superlu: Amesos interface to Xioye Li's SuperLU 3.0 serial code.

Class Amesos_Superlu solves the linear systems of equations A X = B, where A is defined as an Epetra_RowMatrix, and X and B are two Epetra_MultiVector's.

Date:
Last updated on 28-Apr-05.


Constructor & Destructor Documentation

Amesos_Superlu::Amesos_Superlu ( const Epetra_LinearProblem LinearProblem  ) 

Amesos_Superlu Constructor.

Creates an Amesos_Superlu 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

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

Returns true if the solver can handle this matrix shape.

Returns true if the matrix shape is one that the underlying sparse direct solver can handle. Classes that work only on square matrices should return false for rectangular matrices. Classes that work only on symmetric matrices whould return false for non-symmetric matrices.

Implements Amesos_BaseSolver.

int Amesos_Superlu::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_Superlu::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_Superlu::SetUseTranspose ( bool  UseTranspose  )  [inline, virtual]

If set true, X will be set to the solution of AT 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:

Parameters:
UseTranspose -- (In) If true, solve AT X = B, otherwise solve A X = B.
Returns:
Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.

Implements Amesos_BaseSolver.

int Amesos_Superlu::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_Superlu::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 Wed May 12 21:39:57 2010 for Amesos by  doxygen 1.4.7