Amesos_Umfpack Class Reference

Amesos_Umfpack: An object-oriented wrapper for Umfpack. More...

#include <Amesos_Umfpack.h>

Inheritance diagram for Amesos_Umfpack:

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

Public Member Functions

Constructor methods
 Amesos_Umfpack (const Epetra_LinearProblem &LinearProblem)
 Amesos_Umfpack Constructor.
 ~Amesos_Umfpack (void)
 Amesos_Umfpack 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 UMFPACK 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 matrix.
double GetRcond () const
 Returns an estimate of the reciprocal of the condition number.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Updates internal variables.
void PrintTiming ()
 Print timing information.
void PrintStatus ()
 Print information about the factorization and solution phases.

Protected Attributes

bool SymbolicFactorizationOK_
bool NumericFactorizationOK_
void * Symbolic
void * Numeric
vector< int > Ap
vector< int > Ai
vector< double > Aval
int iam
int IsLocal_
int numentries_
int NumGlobalElements_
Epetra_MapSerialMap_
Epetra_CrsMatrixSerialCrsMatrixA_
Epetra_CrsMatrixSerialMatrix_
bool UseTranspose_
const Epetra_LinearProblemProblem_
double Rcond_
bool PrintTiming_
bool PrintStatus_
bool ComputeVectorNorms_
bool ComputeTrueResidual_
int verbose_
int debug_
double ConTime_
double SymTime_
double NumTime_
double SolTime_
double VecTime_
double MatTime_
int NumSymbolicFact_
int NumNumericFact_
int NumSolve_
Epetra_Time Time

Detailed Description

Amesos_Umfpack: An object-oriented wrapper for Umfpack.

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

Umfpack execution can be tuned through a variety of parameters. Amesos_Umfpack.h allows control of these parameters through the following named parameters, ignoring parameters with names that it does not recognize. Where possible, the parameters are common to all direct solvers (although some may ignore them). However, some parameters, in particular tuning parameters, are unique to each solver.


Constructor & Destructor Documentation

Amesos_Umfpack::Amesos_Umfpack const Epetra_LinearProblem LinearProblem  ) 
 

Amesos_Umfpack Constructor.

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

Note: The operator in LinearProblem must be an Epetra_RowMatrix.

Amesos_Umfpack::~Amesos_Umfpack void   ) 
 

Amesos_Umfpack Destructor.

Completely deletes an Amesos_Umfpack object.


Member Function Documentation

bool Amesos_Umfpack::MatrixShapeOK  )  const [virtual]
 

Returns true if UMFPACK can handle this matrix shape.

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

Implements Amesos_BaseSolver.

int Amesos_Umfpack::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_Umfpack::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.

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

Implements Amesos_BaseSolver.

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

  • The next factorization and solve will be performed with the new value of UseTranspose.

Parameters:
In UseTranspose -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_Umfpack::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_Umfpack::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:42:57 2008 for Amesos by doxygen 1.3.9.1