Amesos Package Browser (Single Doxygen Collection) Development
Public Member Functions | Private Member Functions | Private Attributes
Amesos_Superludist Class Reference

Amesos_Superludist: An object-oriented wrapper for Superludist. More...

#include <Amesos_Superludist.h>

Inheritance diagram for Amesos_Superludist:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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
 Print various timig.
void PrintStatus () const
 Print various information about the parameters used by Superludist.
void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list.

Private Member Functions

const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator.
const Epetra_ImportImporter () const
const Epetra_MapUniformMap () const
const Epetra_RowMatrixUniformMatrix () const
Epetra_CrsMatrixCrsUniformMatrix ()
int RedistributeA ()
int ReFactor ()
int Factor ()

Private Attributes

Teuchos::RCP
< Amesos_Superlu_Pimpl
PrivateSuperluData_
const Epetra_LinearProblemProblem_
Epetra_RowMatrixRowMatrixA_
RCP< Epetra_MapUniformMap_
RCP< Epetra_CrsMatrixCrsUniformMatrix_
RCP< Epetra_RowMatrixUniformMatrix_
Teuchos::RCP< Epetra_ImportImporter_
bool ReuseSymbolic_
 Allows FactOption to be used on subsequent calls to pdgssvx from NumericFactorization.
bool Redistribute_
 redistribute the input matrix prior to calling Superludist
int GridCreated_
 true if the SuperLU_DIST's grid has been created (and has to be free'd)
int FactorizationDone_
bool FactorizationOK_
 true if NumericFactorization() has been successfully called.
int NumGlobalRows_
 Global dimension of the matrix.
std::vector< int > Ap_
std::vector< int > Ai_
std::vector< double > Aval_
int * Global_Columns_
 Contains the global ID of local columns.
int nprow_
int npcol_
bool PrintNonzeros_
std::string ColPerm_
std::string RowPerm_
int * perm_c_
int * perm_r_
std::string IterRefine_
bool ReplaceTinyPivot_
bool Equil_
int MtxConvTime_
int MtxRedistTime_
int VecRedistTime_
int NumFactTime_
int SolveTime_
int OverheadTime_
 Amesos_Superludist (const Epetra_LinearProblem &LinearProblem)
 Amesos_Superludist Constructor.
 ~Amesos_Superludist (void)
 Amesos_Superludist 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)
int SetUseTranspose (bool UseTranspose)
 Amesos_Superludist does not support transpose at this time.
const Epetra_LinearProblemGetProblem () const
 Returns the Epetra_LinearProblem.
bool MatrixShapeOK () const
 Returns true if SUPERLUDIST can handle this matrix shape.
bool UseTranspose () const
 Always returns true.

Detailed Description

Amesos_Superludist: An object-oriented wrapper for Superludist.

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

Definition at line 64 of file Amesos_Superludist.h.


Constructor & Destructor Documentation

Amesos_Superludist::Amesos_Superludist ( const Epetra_LinearProblem LinearProblem)

Amesos_Superludist Constructor.

Creates an Amesos_Superludist 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 100 of file Amesos_Superludist.cpp.

Amesos_Superludist::~Amesos_Superludist ( void  )

Amesos_Superludist Destructor.

Completely deletes an Amesos_Superludist object.

Definition at line 150 of file Amesos_Superludist.cpp.


Member Function Documentation

int Amesos_Superludist::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 645 of file Amesos_Superludist.cpp.

int Amesos_Superludist::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 653 of file Amesos_Superludist.cpp.

int Amesos_Superludist::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 688 of file Amesos_Superludist.cpp.

int Amesos_Superludist::SetUseTranspose ( bool  UseTranspose) [inline, virtual]

Amesos_Superludist does not support transpose at this time.

returns 0 if UseTranspose is set to false, else 1 (failure)

Implements Amesos_BaseSolver.

Definition at line 105 of file Amesos_Superludist.h.

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

bool Amesos_Superludist::MatrixShapeOK ( ) const [virtual]

Returns true if SUPERLUDIST can handle this matrix shape.

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

Implements Amesos_BaseSolver.

Definition at line 635 of file Amesos_Superludist.cpp.

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

Always returns true.

Implements Amesos_BaseSolver.

Definition at line 119 of file Amesos_Superludist.h.

int Amesos_Superludist::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 176 of file Amesos_Superludist.cpp.

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

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 125 of file Amesos_Superludist.h.

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

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 128 of file Amesos_Superludist.h.

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

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 131 of file Amesos_Superludist.h.

void Amesos_Superludist::PrintTiming ( ) const [virtual]

Print various timig.

Implements Amesos_BaseSolver.

Definition at line 811 of file Amesos_Superludist.cpp.

void Amesos_Superludist::PrintStatus ( ) const [virtual]

Print various information about the parameters used by Superludist.

Implements Amesos_BaseSolver.

Definition at line 776 of file Amesos_Superludist.cpp.

void Amesos_Superludist::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 140 of file Amesos_Superludist.h.

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

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

Implements Amesos_BaseSolver.

Definition at line 143 of file Amesos_Superludist.h.

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

Definition at line 145 of file Amesos_Superludist.h.

const Epetra_Map& Amesos_Superludist::UniformMap ( ) const [inline, private]

Definition at line 150 of file Amesos_Superludist.h.

const Epetra_RowMatrix& Amesos_Superludist::UniformMatrix ( ) const [inline, private]

Definition at line 155 of file Amesos_Superludist.h.

Epetra_CrsMatrix& Amesos_Superludist::CrsUniformMatrix ( ) [inline, private]

Definition at line 160 of file Amesos_Superludist.h.

int Amesos_Superludist::RedistributeA ( ) [private]

Definition at line 244 of file Amesos_Superludist.cpp.

int Amesos_Superludist::ReFactor ( ) [private]

Definition at line 547 of file Amesos_Superludist.cpp.

int Amesos_Superludist::Factor ( void  ) [private]

Definition at line 305 of file Amesos_Superludist.cpp.


Member Data Documentation

Definition at line 169 of file Amesos_Superludist.h.

Definition at line 176 of file Amesos_Superludist.h.

Definition at line 177 of file Amesos_Superludist.h.

Definition at line 179 of file Amesos_Superludist.h.

Definition at line 180 of file Amesos_Superludist.h.

Definition at line 181 of file Amesos_Superludist.h.

Definition at line 182 of file Amesos_Superludist.h.

Allows FactOption to be used on subsequent calls to pdgssvx from NumericFactorization.

Definition at line 185 of file Amesos_Superludist.h.

redistribute the input matrix prior to calling Superludist

Definition at line 187 of file Amesos_Superludist.h.

true if the SuperLU_DIST's grid has been created (and has to be free'd)

Definition at line 190 of file Amesos_Superludist.h.

Definition at line 191 of file Amesos_Superludist.h.

true if NumericFactorization() has been successfully called.

Definition at line 193 of file Amesos_Superludist.h.

Global dimension of the matrix.

Definition at line 196 of file Amesos_Superludist.h.

std::vector<int> Amesos_Superludist::Ap_ [private]

Definition at line 199 of file Amesos_Superludist.h.

std::vector<int> Amesos_Superludist::Ai_ [private]

Definition at line 200 of file Amesos_Superludist.h.

std::vector<double> Amesos_Superludist::Aval_ [private]

Definition at line 201 of file Amesos_Superludist.h.

Contains the global ID of local columns.

Definition at line 203 of file Amesos_Superludist.h.

Definition at line 205 of file Amesos_Superludist.h.

Definition at line 206 of file Amesos_Superludist.h.

Definition at line 208 of file Amesos_Superludist.h.

std::string Amesos_Superludist::ColPerm_ [private]

Definition at line 209 of file Amesos_Superludist.h.

std::string Amesos_Superludist::RowPerm_ [private]

Definition at line 210 of file Amesos_Superludist.h.

Definition at line 211 of file Amesos_Superludist.h.

Definition at line 212 of file Amesos_Superludist.h.

std::string Amesos_Superludist::IterRefine_ [private]

Definition at line 213 of file Amesos_Superludist.h.

Definition at line 214 of file Amesos_Superludist.h.

Definition at line 215 of file Amesos_Superludist.h.

Definition at line 217 of file Amesos_Superludist.h.

Definition at line 217 of file Amesos_Superludist.h.

Definition at line 217 of file Amesos_Superludist.h.

Definition at line 218 of file Amesos_Superludist.h.

Definition at line 218 of file Amesos_Superludist.h.

Definition at line 218 of file Amesos_Superludist.h.


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