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

Amesos_Dscpack: An object-oriented wrapper for Dscpack. More...

#include <Amesos_Dscpack.h>

Inheritance diagram for Amesos_Dscpack:
Inheritance graph
[legend]

List of all members.

Private Member Functions

const Epetra_ImportImporter () const
const Epetra_MapDscRowMap () const
const Epetra_MapDscColMap () const
int PerformSymbolicFactorization ()
 Performs the symbolic factorization.
int PerformNumericFactorization ()
 Performs the numeric factorization.

Private Attributes

const Epetra_LinearProblemProblem_
 Pointer to the linear problem.
Teuchos::RCP
< Amesos_Dscpack_Pimpl
PrivateDscpackData_
bool FirstCallToSolve_
bool A_and_LU_built
 Tells us whether to free them.
int * GlobalStructNewColNum
int * GlobalStructNewNum
int * GlobalStructOwner
int * LocalStructOldNum
int MyDscRank
int DscNumProcs
int NumLocalCols
int NumGlobalCols
int NumLocalStructs
int NumLocalNonz
RCP< Epetra_ImportImporter_
RCP< Epetra_MapDscColMap_
RCP< Epetra_MapDscRowMap_
int MaxProcs_
int MtxRedistTime_
int MtxConvTime_
int VecRedistTime_
int SymFactTime_
int NumFactTime_
int SolveTime_
int OverheadTime_
int TotalMemory_
 Amesos_Dscpack (const Epetra_LinearProblem &LinearProblem)
 Amesos_Dscpack Constructor.
 ~Amesos_Dscpack (void)
 Amesos_Dscpack 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 DSCPACK 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_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator.
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.

Detailed Description

Amesos_Dscpack: An object-oriented wrapper for Dscpack.

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

Definition at line 60 of file Amesos_Dscpack.h.


Constructor & Destructor Documentation

Amesos_Dscpack::Amesos_Dscpack ( const Epetra_LinearProblem LinearProblem)

Amesos_Dscpack Constructor.

Creates an Amesos_Dscpack 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 48 of file Amesos_Dscpack.cpp.

Amesos_Dscpack::~Amesos_Dscpack ( void  )

Amesos_Dscpack Destructor.

Completely deletes an Amesos_Dscpack object.

Definition at line 69 of file Amesos_Dscpack.cpp.


Member Function Documentation

int Amesos_Dscpack::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 429 of file Amesos_Dscpack.cpp.

int Amesos_Dscpack::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 445 of file Amesos_Dscpack.cpp.

int Amesos_Dscpack::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 461 of file Amesos_Dscpack.cpp.

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

bool Amesos_Dscpack::MatrixShapeOK ( ) const [virtual]

Returns true if DSCPACK can handle this matrix shape.

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

Implements Amesos_BaseSolver.

Definition at line 415 of file Amesos_Dscpack.cpp.

int Amesos_Dscpack::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_Dscpack.h.

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

Returns the current UseTranspose setting.

Implements Amesos_BaseSolver.

Definition at line 110 of file Amesos_Dscpack.h.

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

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

Implements Amesos_BaseSolver.

Definition at line 115 of file Amesos_Dscpack.h.

int Amesos_Dscpack::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 83 of file Amesos_Dscpack.cpp.

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

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 120 of file Amesos_Dscpack.h.

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

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 123 of file Amesos_Dscpack.h.

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

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 126 of file Amesos_Dscpack.h.

void Amesos_Dscpack::PrintTiming ( ) const [virtual]

Prints timing information.

Implements Amesos_BaseSolver.

Definition at line 583 of file Amesos_Dscpack.cpp.

void Amesos_Dscpack::PrintStatus ( ) const [virtual]

Prints information about the factorization and solution phases.

Implements Amesos_BaseSolver.

Definition at line 550 of file Amesos_Dscpack.cpp.

void Amesos_Dscpack::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 135 of file Amesos_Dscpack.h.

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

Definition at line 141 of file Amesos_Dscpack.h.

const Epetra_Map& Amesos_Dscpack::DscRowMap ( ) const [inline, private]

Definition at line 146 of file Amesos_Dscpack.h.

const Epetra_Map& Amesos_Dscpack::DscColMap ( ) const [inline, private]

Definition at line 151 of file Amesos_Dscpack.h.

int Amesos_Dscpack::PerformSymbolicFactorization ( ) [private]

Performs the symbolic factorization.

Definition at line 108 of file Amesos_Dscpack.cpp.

int Amesos_Dscpack::PerformNumericFactorization ( ) [private]

Performs the numeric factorization.

Definition at line 294 of file Amesos_Dscpack.cpp.


Member Data Documentation

Pointer to the linear problem.

Definition at line 163 of file Amesos_Dscpack.h.

Definition at line 165 of file Amesos_Dscpack.h.

Definition at line 167 of file Amesos_Dscpack.h.

Tells us whether to free them.

Definition at line 169 of file Amesos_Dscpack.h.

Definition at line 170 of file Amesos_Dscpack.h.

Definition at line 171 of file Amesos_Dscpack.h.

Definition at line 172 of file Amesos_Dscpack.h.

Definition at line 173 of file Amesos_Dscpack.h.

Definition at line 175 of file Amesos_Dscpack.h.

Definition at line 176 of file Amesos_Dscpack.h.

Definition at line 177 of file Amesos_Dscpack.h.

Definition at line 178 of file Amesos_Dscpack.h.

Definition at line 179 of file Amesos_Dscpack.h.

Definition at line 180 of file Amesos_Dscpack.h.

Definition at line 182 of file Amesos_Dscpack.h.

Definition at line 183 of file Amesos_Dscpack.h.

Definition at line 184 of file Amesos_Dscpack.h.

Definition at line 186 of file Amesos_Dscpack.h.

Definition at line 188 of file Amesos_Dscpack.h.

Definition at line 188 of file Amesos_Dscpack.h.

Definition at line 188 of file Amesos_Dscpack.h.

Definition at line 189 of file Amesos_Dscpack.h.

Definition at line 189 of file Amesos_Dscpack.h.

Definition at line 189 of file Amesos_Dscpack.h.

Definition at line 189 of file Amesos_Dscpack.h.

Definition at line 192 of file Amesos_Dscpack.h.


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