Amesos Package Browser (Single Doxygen Collection) Development
Private Attributes
Amesos_Umfpack Class Reference

Class Amesos_Umfpack: An object-oriented wrapper for UMFPACK. More...

#include <Amesos_Umfpack.h>

Inheritance diagram for Amesos_Umfpack:
Inheritance graph
[legend]

List of all members.

Private Attributes

void * Symbolic
 Umfpack internal opaque object.
void * Numeric
 Umfpack internal opaque object.
std::vector< int > Ap
 Ap, Ai, Aval form the compressed row storage used by Umfpack.
std::vector< int > Ai
std::vector< double > Aval
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()
Teuchos::RCP< Epetra_MapSerialMap_
 Points to a Serial Map (unused if IsLocal == 1 )
Epetra_RowMatrixSerialMatrix_
 Points to a Serial Copy of A.
Teuchos::RCP< Epetra_CrsMatrixSerialCrsMatrixA_
bool UseTranspose_
 If true, solve the problem with the transpose.
const Epetra_LinearProblemProblem_
 Pointer to the linear problem to solve.
double Rcond_
 Reciprocal condition number estimate.
bool RcondValidOnAllProcs_
Teuchos::RCP< Epetra_ImportImportToSerial_
 Importer from distributed to serial (all rows on process 0).
int MtxConvTime_
 Quick access pointers to internal timer data.
int MtxRedistTime_
int VecRedistTime_
int SymFactTime_
int NumFactTime_
int SolveTime_
int OverheadTime_
 Amesos_Umfpack (const Epetra_LinearProblem &LinearProblem)
 Amesos_Umfpack Constructor.
 ~Amesos_Umfpack (void)
 Amesos_Umfpack 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 UMFPACK 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.
double GetRcond () const
 Returns an estimate of the reciprocal of the condition number.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Updates internal variables.
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
 Prints timing information.
void PrintStatus () const
 Prints 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.
Epetra_RowMatrixMatrix ()
 Returns a pointer to the linear system matrix.
int ConvertToSerial (const bool FirstTime)
 Converts matrix to a serial Epetra_CrsMatrix.
int ConvertToUmfpackCRS ()
int PerformSymbolicFactorization ()
int PerformNumericFactorization ()
const Epetra_ImportImporter () const
const Epetra_MapSerialMap () const
const Epetra_CrsMatrixSerialCrsMatrix () const
Epetra_CrsMatrixSerialCrsMatrix ()

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.

Definition at line 70 of file Amesos_Umfpack.h.


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.

Definition at line 50 of file Amesos_Umfpack.cpp.

Amesos_Umfpack::~Amesos_Umfpack ( void  )

Amesos_Umfpack Destructor.

Completely deletes an Amesos_Umfpack object.

Definition at line 86 of file Amesos_Umfpack.cpp.


Member Function Documentation

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

<br >Preconditions:

<br >Postconditions:

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

Implements Amesos_BaseSolver.

Definition at line 362 of file Amesos_Umfpack.cpp.

int Amesos_Umfpack::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 402 of file Amesos_Umfpack.cpp.

int Amesos_Umfpack::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 442 of file Amesos_Umfpack.cpp.

const Epetra_LinearProblem* Amesos_Umfpack::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 107 of file Amesos_Umfpack.h.

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.

Definition at line 351 of file Amesos_Umfpack.cpp.

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:
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 115 of file Amesos_Umfpack.h.

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

Returns the current UseTranspose setting.

Implements Amesos_BaseSolver.

Definition at line 117 of file Amesos_Umfpack.h.

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

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

Implements Amesos_BaseSolver.

Definition at line 119 of file Amesos_Umfpack.h.

double Amesos_Umfpack::GetRcond ( ) const

Returns an estimate of the reciprocal of the condition number.

Definition at line 341 of file Amesos_Umfpack.cpp.

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

Definition at line 236 of file Amesos_Umfpack.cpp.

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

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 132 of file Amesos_Umfpack.h.

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

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 135 of file Amesos_Umfpack.h.

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

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 138 of file Amesos_Umfpack.h.

void Amesos_Umfpack::PrintTiming ( ) const [virtual]

Prints timing information.

Implements Amesos_BaseSolver.

Definition at line 578 of file Amesos_Umfpack.cpp.

void Amesos_Umfpack::PrintStatus ( ) const [virtual]

Prints information about the factorization and solution phases.

Implements Amesos_BaseSolver.

Definition at line 558 of file Amesos_Umfpack.cpp.

void Amesos_Umfpack::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 147 of file Amesos_Umfpack.h.

Epetra_RowMatrix* Amesos_Umfpack::Matrix ( ) [inline, private]

Returns a pointer to the linear system matrix.

Definition at line 155 of file Amesos_Umfpack.h.

int Amesos_Umfpack::ConvertToSerial ( const bool  FirstTime) [private]

Converts matrix to a serial Epetra_CrsMatrix.

Definition at line 101 of file Amesos_Umfpack.cpp.

int Amesos_Umfpack::ConvertToUmfpackCRS ( ) [private]

Definition at line 181 of file Amesos_Umfpack.cpp.

int Amesos_Umfpack::PerformSymbolicFactorization ( ) [private]

Definition at line 251 of file Amesos_Umfpack.cpp.

int Amesos_Umfpack::PerformNumericFactorization ( ) [private]

Definition at line 272 of file Amesos_Umfpack.cpp.

const Epetra_Import& Amesos_Umfpack::Importer ( ) const [inline, private]

Definition at line 201 of file Amesos_Umfpack.h.

const Epetra_Map& Amesos_Umfpack::SerialMap ( ) const [inline, private]

Definition at line 206 of file Amesos_Umfpack.h.

const Epetra_CrsMatrix& Amesos_Umfpack::SerialCrsMatrix ( ) const [inline, private]

Definition at line 211 of file Amesos_Umfpack.h.

Epetra_CrsMatrix& Amesos_Umfpack::SerialCrsMatrix ( ) [inline, private]

Definition at line 216 of file Amesos_Umfpack.h.


Member Data Documentation

void* Amesos_Umfpack::Symbolic [private]

Umfpack internal opaque object.

Definition at line 224 of file Amesos_Umfpack.h.

void* Amesos_Umfpack::Numeric [private]

Umfpack internal opaque object.

Definition at line 226 of file Amesos_Umfpack.h.

std::vector<int> Amesos_Umfpack::Ap [private]

Ap, Ai, Aval form the compressed row storage used by Umfpack.

Definition at line 229 of file Amesos_Umfpack.h.

std::vector<int> Amesos_Umfpack::Ai [private]

Definition at line 230 of file Amesos_Umfpack.h.

std::vector<double> Amesos_Umfpack::Aval [private]

Definition at line 231 of file Amesos_Umfpack.h.

int Amesos_Umfpack::IsLocal_ [private]

1 if Problem_->GetOperator() is stored entirely on process 0

Definition at line 234 of file Amesos_Umfpack.h.

Number of non-zero entries in Problem_->GetOperator()

Definition at line 236 of file Amesos_Umfpack.h.

Number of rows and columns in the Problem_->GetOperator()

Definition at line 238 of file Amesos_Umfpack.h.

Points to a Serial Map (unused if IsLocal == 1 )

Definition at line 241 of file Amesos_Umfpack.h.

Points to a Serial Copy of A.

Definition at line 246 of file Amesos_Umfpack.h.

Definition at line 248 of file Amesos_Umfpack.h.

If true, solve the problem with the transpose.

Definition at line 251 of file Amesos_Umfpack.h.

Pointer to the linear problem to solve.

Definition at line 253 of file Amesos_Umfpack.h.

double Amesos_Umfpack::Rcond_ [mutable, private]

Reciprocal condition number estimate.

Definition at line 255 of file Amesos_Umfpack.h.

bool Amesos_Umfpack::RcondValidOnAllProcs_ [mutable, private]

Definition at line 257 of file Amesos_Umfpack.h.

Importer from distributed to serial (all rows on process 0).

Definition at line 259 of file Amesos_Umfpack.h.

Quick access pointers to internal timer data.

Definition at line 262 of file Amesos_Umfpack.h.

Definition at line 262 of file Amesos_Umfpack.h.

Definition at line 262 of file Amesos_Umfpack.h.

Definition at line 263 of file Amesos_Umfpack.h.

Definition at line 263 of file Amesos_Umfpack.h.

Definition at line 263 of file Amesos_Umfpack.h.

Definition at line 263 of file Amesos_Umfpack.h.


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