Amesos Package Browser (Single Doxygen Collection) Development
Protected Member Functions | Protected Attributes
Amesos_Lapack Class Reference

Amesos_Lapack: an interface to LAPACK. More...

#include <Amesos_Lapack.h>

Inheritance diagram for Amesos_Lapack:
Inheritance graph
[legend]

List of all members.

Protected Member Functions

const Epetra_RowMatrixMatrix () 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.
const Epetra_MapSerialMap ()
 Returns a reference to serial map (that with all elements on process 0). Builds SerialMap_ if necessary or required.
Epetra_RowMatrixSerialMatrix ()
 Returns a reference to serial matrix (that with all rows on process 0). Builds SerialMap_ if necessary or required.
Epetra_CrsMatrixSerialCrsMatrix ()
const Epetra_ImportImporter ()
 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 DistributedToSerial ()
 Converts a distributed matrix to serial matrix.
int SerialToDense ()
 Converts a serial matrix to dense format.
int DenseToFactored ()
 Factors the matrix using LAPACK.

Protected Attributes

Teuchos::RCP
< Teuchos::ParameterList
pl_
Teuchos::RCP< Epetra_RowMatrixSerialMatrix_
Teuchos::RCP< Epetra_CrsMatrixSerialCrsMatrix_
Teuchos::RCP< Epetra_MapSerialMap_
Teuchos::RCP< Epetra_ImportImporter_
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_LinearProblemProblem_
 Pointer to the linear problem.
int MtxRedistTime_
 Quick access ids for the individual timings.
int MtxConvTime_
int VecRedistTime_
int SymFactTime_
int NumFactTime_
int SolveTime_
int NumGlobalRows_
int NumGlobalNonzeros_
Teuchos::RCP
< Teuchos::ParameterList
ParameterList_
 Amesos_Lapack (const Epetra_LinearProblem &LinearProblem)
 Amesos_Lapack Constructor.
 ~Amesos_Lapack (void)
 Amesos_Lapack 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_in)
 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.
void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 Use this parameter list to read values from.
Teuchos::RCP
< Teuchos::ParameterList
unsetParameterList ()
 This is an empty stub.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Deprecated - Sets parameters.
int GEEV (Epetra_Vector &Er, Epetra_Vector &Ei)
 Computes the eigenvalues of the linear system matrix using DGEEV.
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
 Print timing information.
void PrintStatus () const
 Print information about the factorization and solution phases.
void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list.

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:
Last updated on 16-Mar-05.
Author:
Marzio Sala, 9214.

Definition at line 64 of file Amesos_Lapack.h.


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.

Definition at line 39 of file Amesos_Lapack.cpp.

Amesos_Lapack::~Amesos_Lapack ( void  )

Amesos_Lapack Destructor.

Completely deletes an Amesos_Lapack object.

Definition at line 74 of file Amesos_Lapack.cpp.


Member Function Documentation

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

<br >Preconditions:

<br >Postconditions:

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

Implements Amesos_BaseSolver.

Definition at line 127 of file Amesos_Lapack.cpp.

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

  • GetProblem().GetOperator() != 0 (return -1)
  • MatrixShapeOk(GetProblem().GetOperator()) == true (return -6)
  • The non-zero structure of the matrix should not have changed since the last call to SymbolicFactorization(). (return -2 if the number of non-zeros changes) Other changes can have arbitrary consequences.
  • The distribution of the matrix should not have changed since the last call to SymbolicFactorization()
  • The matrix should be indexed from 0 to n-1, unless the parameter "Reindex" was set to "true" prior to the call to SymbolicFactorization(). (return -3 - if caught)
  • The paremeter "Reindex" should not be set to "true" except on CrsMatrices. (return -4)
  • The paremeter "Reindex" should not be set to "true" unless Amesos was built with EpetraExt, i.e. with --enable-epetraext on the configure line. (return -4)
  • Internal errors retur -5.

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

Definition at line 170 of file Amesos_Lapack.cpp.

int Amesos_Lapack::Solve ( ) [virtual]

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

<br >Preconditions:

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

Definition at line 193 of file Amesos_Lapack.cpp.

const Epetra_LinearProblem* Amesos_Lapack::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.

Definition at line 101 of file Amesos_Lapack.h.

bool Amesos_Lapack::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.

Definition at line 104 of file Amesos_Lapack.cpp.

int Amesos_Lapack::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:
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.

Definition at line 105 of file Amesos_Lapack.h.

bool Amesos_Lapack::UseTranspose ( ) const [inline, virtual]

Returns the current UseTranspose setting.

Implements Amesos_BaseSolver.

Definition at line 110 of file Amesos_Lapack.h.

const Epetra_Comm& Amesos_Lapack::Comm ( ) const [inline, virtual]

Returns a pointer to the Epetra_Comm communicator associated with this operator.

Implements Amesos_BaseSolver.

Definition at line 112 of file Amesos_Lapack.h.

void Amesos_Lapack::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList) [virtual]

Use this parameter list to read values from.

Redefined from Teuchos::ParameterListAcceptor

Reimplemented from Amesos_BaseSolver.

Definition at line 60 of file Amesos_Lapack.cpp.

Teuchos::RCP< Teuchos::ParameterList > Amesos_Lapack::unsetParameterList ( ) [virtual]

This is an empty stub.

Reimplemented from Amesos_BaseSolver.

Definition at line 53 of file Amesos_Lapack.cpp.

int Amesos_Lapack::SetParameters ( Teuchos::ParameterList ParameterList) [virtual]

Deprecated - Sets parameters.

Implements Amesos_BaseSolver.

Definition at line 85 of file Amesos_Lapack.cpp.

int Amesos_Lapack::GEEV ( Epetra_Vector Er,
Epetra_Vector Ei 
)

Computes the eigenvalues of the linear system matrix using DGEEV.

Parameters:
Er- (Out) On processor zero only, it will contain the real component of the eigenvalues.
Ei- (Out) On processor zero only, it will contain the imaginary component of the eigenvalues.
Note:
Er and Ei must have been allocated so that the local length on processor 0 equals the global size of the matrix.

Definition at line 359 of file Amesos_Lapack.cpp.

int Amesos_Lapack::NumSymbolicFact ( ) const [inline, virtual]

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 141 of file Amesos_Lapack.h.

int Amesos_Lapack::NumNumericFact ( ) const [inline, virtual]

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 144 of file Amesos_Lapack.h.

int Amesos_Lapack::NumSolve ( ) const [inline, virtual]

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 147 of file Amesos_Lapack.h.

void Amesos_Lapack::PrintTiming ( ) const [virtual]

Print timing information.

Implements Amesos_BaseSolver.

Definition at line 475 of file Amesos_Lapack.cpp.

void Amesos_Lapack::PrintStatus ( ) const [virtual]

Print information about the factorization and solution phases.

Implements Amesos_BaseSolver.

Definition at line 447 of file Amesos_Lapack.cpp.

void Amesos_Lapack::GetTiming ( Teuchos::ParameterList TimingParameterList) const [inline, virtual]

Extracts timing information from the current solver and places it in the parameter list.

Reimplemented from Amesos_BaseSolver.

Definition at line 156 of file Amesos_Lapack.h.

const Epetra_RowMatrix* Amesos_Lapack::Matrix ( ) const [inline, protected]

Returns a pointer to the linear system matrix.

Definition at line 163 of file Amesos_Lapack.h.

int Amesos_Lapack::NumGlobalRows ( ) const [inline, protected]

Returns the number of global rows, or -1 if Matrix() returns 0.

Definition at line 169 of file Amesos_Lapack.h.

int Amesos_Lapack::NumMyRows ( ) const [inline, protected]

Returns the number of local rows, or -1 if Matrix() returns 0.

Definition at line 175 of file Amesos_Lapack.h.

const Epetra_Map& Amesos_Lapack::SerialMap ( ) [inline, protected]

Returns a reference to serial map (that with all elements on process 0). Builds SerialMap_ if necessary or required.

Definition at line 181 of file Amesos_Lapack.h.

Epetra_RowMatrix& Amesos_Lapack::SerialMatrix ( ) [inline, protected]

Returns a reference to serial matrix (that with all rows on process 0). Builds SerialMap_ if necessary or required.

Definition at line 187 of file Amesos_Lapack.h.

Epetra_CrsMatrix& Amesos_Lapack::SerialCrsMatrix ( ) [inline, protected]

Definition at line 192 of file Amesos_Lapack.h.

const Epetra_Import& Amesos_Lapack::Importer ( ) [inline, protected]

Returns a reference to the importer map. Builds SerialMap_ if necessary or required.

Definition at line 198 of file Amesos_Lapack.h.

int Amesos_Lapack::SolveSerial ( Epetra_MultiVector X,
const Epetra_MultiVector B 
) [protected]

Solves the linear system, when only one process is used.

Definition at line 217 of file Amesos_Lapack.cpp.

int Amesos_Lapack::SolveDistributed ( Epetra_MultiVector X,
const Epetra_MultiVector B 
) [protected]

Solves the linear system, when more than one process is used.

Definition at line 246 of file Amesos_Lapack.cpp.

int Amesos_Lapack::DistributedToSerial ( ) [protected]

Converts a distributed matrix to serial matrix.

Definition at line 339 of file Amesos_Lapack.cpp.

int Amesos_Lapack::SerialToDense ( ) [protected]

Converts a serial matrix to dense format.

Definition at line 291 of file Amesos_Lapack.cpp.

int Amesos_Lapack::DenseToFactored ( ) [protected]

Factors the matrix using LAPACK.

Definition at line 432 of file Amesos_Lapack.cpp.


Member Data Documentation

Definition at line 203 of file Amesos_Lapack.h.

Definition at line 222 of file Amesos_Lapack.h.

Definition at line 223 of file Amesos_Lapack.h.

Definition at line 224 of file Amesos_Lapack.h.

Definition at line 225 of file Amesos_Lapack.h.

Dense matrix.

Definition at line 228 of file Amesos_Lapack.h.

Dense LHS.

Definition at line 230 of file Amesos_Lapack.h.

Dense RHS.

Definition at line 232 of file Amesos_Lapack.h.

Linear problem for dense matrix and vectors.

Definition at line 234 of file Amesos_Lapack.h.

bool Amesos_Lapack::UseTranspose_ [protected]

If true, the linear system with the transpose will be solved.

Definition at line 237 of file Amesos_Lapack.h.

Pointer to the linear problem.

Definition at line 239 of file Amesos_Lapack.h.

Quick access ids for the individual timings.

Definition at line 242 of file Amesos_Lapack.h.

int Amesos_Lapack::MtxConvTime_ [protected]

Definition at line 242 of file Amesos_Lapack.h.

Definition at line 242 of file Amesos_Lapack.h.

int Amesos_Lapack::SymFactTime_ [protected]

Definition at line 242 of file Amesos_Lapack.h.

int Amesos_Lapack::NumFactTime_ [protected]

Definition at line 242 of file Amesos_Lapack.h.

int Amesos_Lapack::SolveTime_ [protected]

Definition at line 242 of file Amesos_Lapack.h.

Definition at line 244 of file Amesos_Lapack.h.

Definition at line 245 of file Amesos_Lapack.h.

Definition at line 247 of file Amesos_Lapack.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines