Amesos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
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_RowMatrix * GetUserMatrix () const
 
Epetra_MultiVector * GetLHS () const
 
Epetra_MultiVector * GetRHS () const
 
bool GetTrans () const
 
void SetTrans (bool trans)
 
int SetSpoolesDefaults ()
 
int Solve ()
 

Protected Attributes

Epetra_Operator * UserOperator_
 
Epetra_RowMatrix * UserMatrix_
 
Epetra_Operator * PrecOperator_
 
Epetra_RowMatrix * PrecMatrix_
 
Epetra_MultiVector * X_
 
Epetra_MultiVector * B_
 
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() [1/2]

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

Definition at line 52 of file SpoolesOO.cpp.

◆ SpoolesOO() [2/2]

SpoolesOO::SpoolesOO ( )

Definition at line 67 of file SpoolesOO.cpp.

◆ ~SpoolesOO()

SpoolesOO::~SpoolesOO ( void )
virtual

Definition at line 73 of file SpoolesOO.cpp.

Member Function Documentation

◆ SetUserMatrix()

int SpoolesOO::SetUserMatrix ( Epetra_RowMatrix * UserMatrix)

Definition at line 79 of file SpoolesOO.cpp.

◆ SetLHS()

int SpoolesOO::SetLHS ( Epetra_MultiVector * X)

Definition at line 90 of file SpoolesOO.cpp.

◆ SetRHS()

int SpoolesOO::SetRHS ( Epetra_MultiVector * B)

Definition at line 99 of file SpoolesOO.cpp.

◆ GetUserMatrix()

Epetra_RowMatrix * SpoolesOO::GetUserMatrix ( ) const
inline

Definition at line 66 of file SpoolesOO.h.

◆ GetLHS()

Epetra_MultiVector * SpoolesOO::GetLHS ( ) const
inline

Definition at line 68 of file SpoolesOO.h.

◆ GetRHS()

Epetra_MultiVector * SpoolesOO::GetRHS ( ) const
inline

Definition at line 70 of file SpoolesOO.h.

◆ GetTrans()

bool SpoolesOO::GetTrans ( ) const
inline

Definition at line 72 of file SpoolesOO.h.

◆ SetTrans()

void SpoolesOO::SetTrans ( bool trans)
inline

Definition at line 74 of file SpoolesOO.h.

◆ SetSpoolesDefaults()

int SpoolesOO::SetSpoolesDefaults ( )

Definition at line 108 of file SpoolesOO.cpp.

◆ Solve()

int SpoolesOO::Solve ( )

Definition at line 128 of file SpoolesOO.cpp.

Member Data Documentation

◆ UserOperator_

Epetra_Operator* SpoolesOO::UserOperator_
protected

Definition at line 82 of file SpoolesOO.h.

◆ UserMatrix_

Epetra_RowMatrix* SpoolesOO::UserMatrix_
protected

Definition at line 83 of file SpoolesOO.h.

◆ PrecOperator_

Epetra_Operator* SpoolesOO::PrecOperator_
protected

Definition at line 84 of file SpoolesOO.h.

◆ PrecMatrix_

Epetra_RowMatrix* SpoolesOO::PrecMatrix_
protected

Definition at line 85 of file SpoolesOO.h.

◆ X_

Epetra_MultiVector* SpoolesOO::X_
protected

Definition at line 86 of file SpoolesOO.h.

◆ B_

Epetra_MultiVector* SpoolesOO::B_
protected

Definition at line 87 of file SpoolesOO.h.

◆ Transpose_

bool SpoolesOO::Transpose_
protected

Definition at line 90 of file SpoolesOO.h.

◆ x_LDA_

int SpoolesOO::x_LDA_
protected

Definition at line 92 of file SpoolesOO.h.

◆ x_

double* SpoolesOO::x_
protected

Definition at line 93 of file SpoolesOO.h.

◆ b_LDA_

int SpoolesOO::b_LDA_
protected

Definition at line 94 of file SpoolesOO.h.

◆ b_

double* SpoolesOO::b_
protected

Definition at line 95 of file SpoolesOO.h.

◆ inConstructor_

bool SpoolesOO::inConstructor_
protected

Definition at line 96 of file SpoolesOO.h.


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