Amesos_Dscpack Class Reference

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

#include <Amesos_Dscpack.h>

Inheritance diagram for Amesos_Dscpack:

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

Public Member Functions

Constructor methods
 Amesos_Dscpack (const Epetra_LinearProblem &LinearProblem)
 Amesos_Dscpack Constructor.
 ~Amesos_Dscpack (void)
 Amesos_Dscpack 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_LinearProblemGetProblem () const
 Get a pointer to the Problem.
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 matrix.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Sets parameters as specified in the list, returns 0 if successful.
void PrintTiming ()
 Prints timing information.
void PrintStatus ()
 Prints information about the factorization and solution phases.

Protected Member Functions

int PerformSymbolicFactorization ()
 Performs the symbolic factorization.
int PerformNumericFactorization ()
 Performs the numeric factorization.

Protected Attributes

bool IsSymbolicFactorizationOK_
 If true, SymbolicFactorization() has been successfully called.
bool IsNumericFactorizationOK_
 If true, NumericFactorization() has been successfully called.
Epetra_CrsGraphDscGraph_
 Distribution specified by DscOrder.
bool UseTranspose_
 Is true, the transpose of the matrix is used.
const Epetra_LinearProblemProblem_
 Pointer to the linear problem.
DSC_Solver MyDSCObject
MPI_Comm MPIC
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
bool PrintTiming_
 If true, prints timing information in the destructor.
bool PrintStatus_
 If true, prints additinal information in the destructor.
bool ComputeVectorNorms_
 If true, computes the norm of rhs and solution.
bool ComputeTrueResidual_
 If true, compute the norm of the real residual.
int verbose_
 Toggles the output level.
double ConTime_
 time to convert to DSCPACK 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 symbolic factorizations
int NumNumericFact_
 number of numeric factorizations
int NumSolve_
 number of solves
Epetra_TimeTime_
 used to track timing
Epetra_ImportImportToSerial_
Epetra_MapDscMap_
int MaxProcs_
int TotalMemory_

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.


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.

Amesos_Dscpack::~Amesos_Dscpack void   ) 
 

Amesos_Dscpack Destructor.

Completely deletes an Amesos_Dscpack object.


Member Function Documentation

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.

int Amesos_Dscpack::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_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:
In UseTranspose -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.

int Amesos_Dscpack::Solve  )  [virtual]
 

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

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

Implements Amesos_BaseSolver.

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

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

Implements Amesos_BaseSolver.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:41:33 2008 for Amesos by doxygen 1.3.9.1