Amesos_Superlu Class Reference

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

#include <Amesos_Superlu.h>

Inheritance diagram for Amesos_Superlu:

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

Public Member Functions

Constructor methods
 Amesos_Superlu (const Epetra_LinearProblem &LinearProblem)
 Amesos_Superlu Constructor.
 ~Amesos_Superlu (void)
 Amesos_Superlu 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).
Additional methods required to support the Epetra_Operator interface.
const Epetra_LinearProblemGetProblem () const
 Get a pointer to the Problem.
bool MatrixShapeOK () const
 Returns true if SUPERLU can handle this matrix shape.
int SetUseTranspose (bool UseTranspose)
 SetUseTranpose(true) is more efficient in Amesos_Superlu.
bool UseTranspose () const
 Returns the current UseTranspose setting.
const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this matrix.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Updates internal variables.

Protected Attributes

SLUData * data_
double * DummyArray
vector< int > Ap_
vector< int > Ai_
vector< double > Aval_
bool FactorizationDone_
bool FactorizationOK_
bool ReuseSymbolic_
bool UseTranspose_
int iam_
int IsLocal_
int numentries_
int NumGlobalElements_
Epetra_MapSerialMap_
Epetra_CrsMatrixSerialCrsMatrixA_
Epetra_CrsMatrixSerialMatrix_
const Epetra_LinearProblemProblem_
vector< int > ColIndicesV_
vector< double > RowValuesV_
vector< double > berr_
vector< double > ferr_
vector< int > perm_r_
vector< int > perm_c_
vector< int > etree_
vector< double > R_
vector< double > C_
char equed_
bool DestroyBandX_

Detailed Description

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

Amesos_Superlu, an object-oriented wrapper for Superlu, will solve a linear systems of equations: A X = B using Epetra objects and the Superlu solver library, where A is an Epetra_RowMatrix and X and B are Epetra_MultiVector objects.


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.

Amesos_Superlu::~Amesos_Superlu void   ) 
 

Amesos_Superlu Destructor.

Completely deletes an Amesos_Superlu object.


Member Function Documentation

bool Amesos_Superlu::MatrixShapeOK  )  const [virtual]
 

Returns true if SUPERLU can handle this matrix shape.

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

Implements Amesos_BaseSolver.

int Amesos_Superlu::NumericFactorization  )  [virtual]
 

Performs NumericFactorization on the matrix A.

In addition to performing numeric factorization (and symbolic factorization if necessary) 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().

preconditions:

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_Superlu::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 subsequent 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.

Amesos_Superlu accepts the following parameters:

  • "Verbose" - boolean:false - If true prints out some debug information
  • "Superlu" - list containing the following parameters:
    • "FactOption" - string:["SamePattern"] "SamePattern-SameRowPerm"
    • "ColPerm" - string:["COLAMD"] "..."
    • "Equil" - boolean:true
    • "fill_fac" - int:-1
    • "panel_size" - int:-1
    • "relax" - int:-1
    • "pivot_thresh" - double:-1
    • "Iter_Refine" - string:["DOUBLE"] "NOREFINE"

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

Implements Amesos_BaseSolver.

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

SetUseTranpose(true) is more efficient in Amesos_Superlu.

  • If SetUseTranspose() is set to true,
    • AT X = B is computed

    • (This is the more efficient operation)
  • else
    • A X = B is computed

    • (This requires a matrix transpose)

Implements Amesos_BaseSolver.

int Amesos_Superlu::Solve  )  [virtual]
 

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

preconditions:

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_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().

preconditions:

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:41:33 2008 for Amesos by doxygen 1.3.9.1