Amesos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
SpoolesOO Class Reference

SpoolesOO: An object-oriented wrapper for Spooles. More...

#include <SpoolesOO.h>

Public Member Functions

 SpoolesOO (Epetra_RowMatrix *A, Epetra_MultiVector *X, Epetra_MultiVector *B)
 
 SpoolesOO ()
 
virtual ~SpoolesOO (void)
 
int SetUserMatrix (Epetra_RowMatrix *UserMatrix)
 
int SetLHS (Epetra_MultiVector *X)
 
int SetRHS (Epetra_MultiVector *B)
 
Epetra_RowMatrixGetUserMatrix () const
 
Epetra_MultiVectorGetLHS () const
 
Epetra_MultiVectorGetRHS () const
 
bool GetTrans () const
 
void SetTrans (bool trans)
 
int SetSpoolesDefaults ()
 
int Solve ()
 

Protected Attributes

Epetra_OperatorUserOperator_
 
Epetra_RowMatrixUserMatrix_
 
Epetra_OperatorPrecOperator_
 
Epetra_RowMatrixPrecMatrix_
 
Epetra_MultiVectorX_
 
Epetra_MultiVectorB_
 
bool Transpose_
 
int x_LDA_
 
double * x_
 
int b_LDA_
 
double * b_
 
bool inConstructor_
 

Detailed Description

SpoolesOO: An object-oriented wrapper for Spooles.

SpoolesOO will solve a linear systems of equations: $ AX=B $, using Epetra objects and the Spooles solver library, where $A$ is an Epetra_Operator or Epetra_RowMatrix (note that the Epetra_Operator class is a base class for Epetra_RowMatrix so that Epetra_RowMatrix isa Epetra_Operator.) $X$ and $B$ are Epetra_MultiVector objects.

Warning
SpoolesOO does not presently support solution of more than one simultaneous right-hand-side.

Definition at line 51 of file SpoolesOO.h.

Constructor & Destructor Documentation

SpoolesOO::SpoolesOO ( Epetra_RowMatrix A,
Epetra_MultiVector X,
Epetra_MultiVector B 
)

Definition at line 52 of file SpoolesOO.cpp.

SpoolesOO::SpoolesOO ( )

Definition at line 67 of file SpoolesOO.cpp.

SpoolesOO::~SpoolesOO ( void  )
virtual

Definition at line 73 of file SpoolesOO.cpp.

Member Function Documentation

int SpoolesOO::SetUserMatrix ( Epetra_RowMatrix UserMatrix)

Definition at line 79 of file SpoolesOO.cpp.

int SpoolesOO::SetLHS ( Epetra_MultiVector X)

Definition at line 90 of file SpoolesOO.cpp.

int SpoolesOO::SetRHS ( Epetra_MultiVector B)

Definition at line 99 of file SpoolesOO.cpp.

Epetra_RowMatrix* SpoolesOO::GetUserMatrix ( ) const
inline

Definition at line 66 of file SpoolesOO.h.

Epetra_MultiVector* SpoolesOO::GetLHS ( ) const
inline

Definition at line 68 of file SpoolesOO.h.

Epetra_MultiVector* SpoolesOO::GetRHS ( ) const
inline

Definition at line 70 of file SpoolesOO.h.

bool SpoolesOO::GetTrans ( ) const
inline

Definition at line 72 of file SpoolesOO.h.

void SpoolesOO::SetTrans ( bool  trans)
inline

Definition at line 74 of file SpoolesOO.h.

int SpoolesOO::SetSpoolesDefaults ( )

Definition at line 108 of file SpoolesOO.cpp.

int SpoolesOO::Solve ( void  )

Definition at line 128 of file SpoolesOO.cpp.

Member Data Documentation

Epetra_Operator* SpoolesOO::UserOperator_
protected

Definition at line 82 of file SpoolesOO.h.

Epetra_RowMatrix* SpoolesOO::UserMatrix_
protected

Definition at line 83 of file SpoolesOO.h.

Epetra_Operator* SpoolesOO::PrecOperator_
protected

Definition at line 84 of file SpoolesOO.h.

Epetra_RowMatrix* SpoolesOO::PrecMatrix_
protected

Definition at line 85 of file SpoolesOO.h.

Epetra_MultiVector* SpoolesOO::X_
protected

Definition at line 86 of file SpoolesOO.h.

Epetra_MultiVector* SpoolesOO::B_
protected

Definition at line 87 of file SpoolesOO.h.

bool SpoolesOO::Transpose_
protected

Definition at line 90 of file SpoolesOO.h.

int SpoolesOO::x_LDA_
protected

Definition at line 92 of file SpoolesOO.h.

double* SpoolesOO::x_
protected

Definition at line 93 of file SpoolesOO.h.

int SpoolesOO::b_LDA_
protected

Definition at line 94 of file SpoolesOO.h.

double* SpoolesOO::b_
protected

Definition at line 95 of file SpoolesOO.h.

bool SpoolesOO::inConstructor_
protected

Definition at line 96 of file SpoolesOO.h.


The documentation for this class was generated from the following files: