DscpackOO Class Reference

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

#include <DscpackOO.h>

Collaboration diagram for DscpackOO:

[legend]
List of all members.

Public Member Functions

Constructor methods
 DscpackOO (const Epetra_LinearProblem &LinearProblem)
 DscpackOO Constructor.
virtual ~DscpackOO (void)
 DscpackOO Destructor.
Post-construction setup methods.
void SetTrans (bool trans)
 Setting the transpose flag to true causes Solve() to compute A^t x = b.
Check/Attribute Access Methods.
bool GetTrans () const
 Return the transpose flag.
int CheckInput () const
 Prints a summary of solver parameters, performs simple sanity checks.
Post-solve access functions
double Condest () const
 Returns the condition number estimate for the current problem, if one exists, returns -1.0 if no estimate.
Solve method
int Solve (bool Factor)
 All computation is performed during the call to Solve().

Protected Attributes

const Epetra_LinearProblemProblem_
DSC_Solver MyDSCObject
MPI_Comm MPIC
bool Factored_
bool FirstCallToSolve_
bool A_and_LU_built
int * GlobalStructNewColNum
int * GlobalStructNewNum
int * GlobalStructOwner
int * LocalStructOldNum
int MyDscRank
int DscNumProcs
int NumLocalCols
int NumGlobalCols
int NumLocalPPPStructs

Detailed Description

DscpackOO: An object-oriented wrapper for Dscpack.

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

Dscpack execution can be tuned through a variety of parameters. DscpackOO.h allows control of these parameters through the following named parameters, ignoring parameters with names that it does not recognize. Where possible, the parameters are common to all direct solvers (although some may ignore them). However, some parameters, in particular tuning parameters, are unique to each solver.


Constructor & Destructor Documentation

DscpackOO::DscpackOO const Epetra_LinearProblem LinearProblem  ) 
 

DscpackOO Constructor.

Creates a DscpackOO instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object. The Epetra_LinearProblem class is the preferred method for passing in the linear problem to DscpackOO because this class provides scaling capabilities and self-consistency checks that are not available when using other constructors.

Note: The operator in LinearProblem must be an Epetra_RowMatrix.

DscpackOO::~DscpackOO void   )  [virtual]
 

DscpackOO Destructor.

Completely deletes a DscpackOO object.


Member Function Documentation

int DscpackOO::CheckInput  )  const
 

Prints a summary of solver parameters, performs simple sanity checks.

Not supported in release 0.1;

double DscpackOO::Condest  )  const
 

Returns the condition number estimate for the current problem, if one exists, returns -1.0 if no estimate.

Not supported in release 0.1

int DscpackOO::Solve bool  Factor  ) 
 

All computation is performed during the call to Solve().

Factor controls whether or not the matrix should be factored prior to the solve. Default is true.


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