Amesos_Lapack Class Reference

Amesos_Lapack: an interface to LAPACK. More...

#include <Amesos_Lapack.h>

Inheritance diagram for Amesos_Lapack:

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

Public Member Functions
Constructor methods
	Amesos_Lapack (const Epetra_LinearProblem &LinearProblem)
	Amesos_Lapack Constructor.
	~Amesos_Lapack (void)
	Amesos_Lapack 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 Amesos_Lapack can handle this matrix shape.
int	SetUseTranspose (bool UseTranspose)
	SetUseTranpose(true).
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.
int	SetParameters (Teuchos::ParameterList &ParameterList)
	Updates internal variables.
void	PrintTiming ()
	Print timing information.
void	PrintStatus ()
	Print information about the factorization and solution phases.
Protected Member Functions
bool	IsSymbolicFactorizationOK ()
	Returns true if SymbolicFactorization() has been successfully called.
bool	IsNumericFactorizationOK ()
	Returns true if SymbolicFactorization() has been successfully called.
const Epetra_RowMatrix *	Matrix () const
	Returns a pointer to the linear system matrix.
int	NumGlobalRows () const
	Returns the number of global rows, or -1 if Matrix() returns 0.
int	NumMyRows () const
	Returns the number of local rows, or -1 if Matrix() returns 0.
int	MyPID () const
	Returns the ID of calling process.
int	NumProc () const
	Returns the number of processes in communicator.
const Epetra_Map &	SerialMap ()
	Returns a reference to serial map (that with all elements on process 0). Builds SerialMap_ if necessary or required.
Epetra_CrsMatrix &	SerialMatrix ()
	Returns a reference to serial matrix (that with all rows on process 0). Builds SerialMap_ if necessary or required.
const Epetra_Import &	RowImporter ()
	Returns a reference to the importer map. Builds SerialMap_ if necessary or required.
int	SolveSerial (Epetra_MultiVector &X, const Epetra_MultiVector &B)
	Solves the linear system, when only one process is used.
int	SolveDistributed (Epetra_MultiVector &X, const Epetra_MultiVector &B)
	Solves the linear system, when more than one process is used.
int	SerialToDense ()
	Convert a serial matrix to dense format. Only for Comm().NumProc() == 1.
int	DistributedToDense ()
	Convert a distributed matrix to dense format. Only for Comm().NumProc() > 1.
Protected Attributes
Epetra_CrsMatrix *	SerialMatrix_
	Points to the Serial matrix (defined on process 0 only).
Epetra_Map *	SerialMap_
	Points to a Serial Map (to import LHS/RHS).
Epetra_Import *	RowImporter_
	Importer from distributed map to SerialMap_.
Epetra_SerialDenseMatrix	DenseMatrix_
	Dense matrix.
Epetra_SerialDenseMatrix	DenseLHS_
	Dense LHS.
Epetra_SerialDenseMatrix	DenseRHS_
	Dense RHS.
Epetra_SerialDenseSolver	DenseSolver_
	Linear problem for dense matrix and vectors.
bool	UseTranspose_
	If true, the linear system with the transpose will be solved.
const Epetra_LinearProblem *	Problem_
	Pointer to the linear problem.
bool	PrintTiming_
	If true, some timing are printed in destructor.
bool	PrintStatus_
	If true, some additional information are printed in destructor.
bool	ComputeVectorNorms_
	If true, solution and rhs norms are computed in Solve().
bool	ComputeTrueResidual_
	If true, the norm of the residual in computed in Solve().
int	verbose_
	If greater than 0, prints out additional information.
double	Threshold_
	Ignore all elements of the matrix whose absolute value if less than Threshold_.
double	AddToDiag_
	Value to be added to the diagonal.
bool	IsSymbolicFactorizationOK_
	If true, SymbolicFactorization() has been successfully called.
bool	IsNumericFactorizationOK_
	If true, NumericFactorization() has been successfully called.
double	ConTime_
	Time to convert to LAPACK 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 calls to SymbolicFactorization().
int	NumNumericFact_
	Number of calls to NumericFactorization().
int	NumSolve_
	Number of calls to Solver().
Epetra_Time *	Time_
	Object used to track times.

---

Detailed Description

Amesos_Lapack: an interface to LAPACK.

Class Amesos_Lapack enables the solution of the distributed linear system, defined by an Epetra_LinearProblem, using LAPACK.

Amesos_Lapack stores the lineaar system matrix as an Epetra_SerialDensMatrix. The linear problem is an Epetra_SerialDenseProblem. Amesos_Lapack factorizes the matrix using DGETRF().

Date:

Sep-04

Author:

Marzio Sala, 9214.

---

Constructor & Destructor Documentation

Amesos_Lapack::Amesos_Lapack (  const Epetra_LinearProblem &  LinearProblem  )

Amesos_Lapack Constructor. Creates an Amesos_Lapack instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object. Note: The operator in LinearProblem must be an Epetra_RowMatrix.

Amesos_Lapack::~Amesos_Lapack (  void   )

Amesos_Lapack Destructor. Completely deletes an Amesos_Lapack object.

---

Member Function Documentation

bool Amesos_Lapack::MatrixShapeOK (   )  const [virtual]

Returns true if Amesos_Lapack can handle this matrix shape. Returns true if the matrix shape is one that KLU can handle. Amesos_Lapack only works with square matrices. Implements Amesos_BaseSolver.

int Amesos_Lapack::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_Lapack::SetParameters (  Teuchos::ParameterList &  ParameterList  )  [virtual]

Updates internal variables. Returns: Integer error code, set to 0 if successful. Implements Amesos_BaseSolver.

int Amesos_Lapack::Solve (   )  [virtual]

Solves A X = B (or AT X = B). Returns: Integer error code, set to 0 if successful. Implements Amesos_BaseSolver.

int Amesos_Lapack::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(). Returns: Integer error code, set to 0 if successful. Implements Amesos_BaseSolver.

---

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

• Amesos_Lapack.h
• Amesos_Lapack.cpp

---