Amesos_Umfpack Class Reference

Class 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_LinearProblem *	GetProblem () 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_Comm &	Comm () 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)
	Sets parameters from the parameters list, returns 0 if successful.
void	PrintTiming ()
	Prints timing information.
void	PrintStatus ()
	Prints information about the factorization and solution phases.
Protected Attributes
bool	IsSymbolicFactorizationOK_
	True if SymbolicFactorization has been done.
bool	IsNumericFactorizationOK_
	True if NumericFactorization has been done.
void *	Symbolic
	Umfpack internal opaque object.
void *	Numeric
	Umfpack internal opaque object.
vector< int >	Ap
	Ap, Ai, Aval form the compressed row storage used by Umfpack.
vector< int >	Ai
vector< double >	Aval
int	iam
	Process number (i.e. Comm().MyPID() ).
int	IsLocal_
	1 if Problem_->GetOperator() is stored entirely on process 0
int	numentries_
	Number of non-zero entries in Problem_->GetOperator().
int	NumGlobalElements_
	Number of rows and columns in the Problem_->GetOperator().
Epetra_Map *	SerialMap_
	Points to a Serial Map (unused if IsLocal == 1 ).
Epetra_RowMatrix *	SerialMatrix_
	Points to a Serial Copy of A.
Epetra_CrsMatrix *	SerialCrsMatrixA_
bool	UseTranspose_
	If true, solve the problem with the transpose.
const Epetra_LinearProblem *	Problem_
	Pointer to the linear problem to solve.
double	Rcond_
	Reciprocal condition number estimate.
bool	PrintTiming_
	If true, prints timing in the destructor.
bool	PrintStatus_
	If true, prints additional information in the destructor.
bool	ComputeVectorNorms_
	If true, prints the norm of LHS and RHS in Solve().
bool	ComputeTrueResidual_
	If true, prints the norm of the computed residual in Solve().
int	verbose_
	Toggles the output level.
double	ConTime_
	time to convert to MUMPS format
double	SymTime_
	time for symbolic factorization
double	NumTime_
	time for numeric factorization
double	SolTime_
	time for solution
double	VecTime_
	time to redistribute vectors
double	MatTime_
	time to redistribute matrix
int	NumSymbolicFact_
	Number of symbolic factorizations.
int	NumNumericFact_
	Number of numeric factorizations.
int	NumSolve_
	Number of solves.
Epetra_Time *	Time_
	Used to track timing.
Epetra_Import *	ImportToSerial_
	Importer from distributed to serial (all rows on process 0).
bool	RcondValidOnAllProcs_

---

Detailed Description

Class 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.

---

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(). 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: SetTranspose() should be called prior to the call to SymbolicFactorization() If NumericFactorization() or Solve() is called after SetTranspose() without an intervening call to SymbolicFactorization() the result is implementation dependent. <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). 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: GetProblem().GetOperator() != 0 (return -1) MatrixShapeOk(GetProblem().GetOperator()) == true (return -6) postconditions: Symbolic Factorization will be performed (or marked to be performed) allowing NumericFactorization() and Solve() to be called. Returns: Integer error code, set to 0 if successful. Implements Amesos_BaseSolver.

---

The documentation for this class was generated from the following files:

• Amesos_Umfpack.h
• Amesos_Umfpack.cpp

---