Ifpack_OverlappingRowMatrix Class Reference

#include <Ifpack_OverlappingRowMatrix.h>

Inheritance diagram for Ifpack_OverlappingRowMatrix:

[legend]
List of all members.

[NOHEADER]

 Ifpack_OverlappingRowMatrix (const Epetra_RowMatrix *Matrix, int OverlapLevel)
 Constructors/Destructors.
 ~Ifpack_OverlappingRowMatrix ()

Matrix data extraction routines

virtual int NumMyRowEntries (int MyRow, int &NumEntries) const
 Returns the number of nonzero entries in MyRow.
virtual int MaxNumEntries () const
 Returns the maximum of NumMyRowEntries() over all rows.
virtual int ExtractMyRowCopy (int MyRow, int Length, int &NumEntries, double *Values, int *Indices) const
 Returns a copy of the specified local row in user-provided arrays.
virtual int ExtractDiagonalCopy (Epetra_Vector &Diagonal) const
 Returns a copy of the main diagonal in a user-provided vector.

Mathematical functions.

virtual int Multiply (bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_RowMatrix multiplied by a Epetra_MultiVector X in Y.
virtual int Solve (bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns result of a local-only solve using a triangular Epetra_RowMatrix with Epetra_MultiVectors X and Y (NOT IMPLEMENTED).
virtual int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
virtual int InvRowSums (Epetra_Vector &x) const
 Computes the sum of absolute values of the rows of the Epetra_RowMatrix, results returned in x (NOT IMPLEMENTED).
virtual int LeftScale (const Epetra_Vector &x)
 Scales the Epetra_RowMatrix on the left with a Epetra_Vector x (NOT IMPLEMENTED).
virtual int InvColSums (Epetra_Vector &x) const
 Computes the sum of absolute values of the columns of the Epetra_RowMatrix, results returned in x (NOT IMPLEMENTED).
virtual int RightScale (const Epetra_Vector &x)
 Scales the Epetra_RowMatrix on the right with a Epetra_Vector x (NOT IMPLEMENTED).

Atribute access functions

virtual bool Filled () const
 If FillComplete() has been called, this query returns true, otherwise it returns false.
virtual double NormInf () const
 Returns the infinity norm of the global matrix.
virtual double NormOne () const
 Returns the one norm of the global matrix.
virtual int NumGlobalNonzeros () const
 Returns the number of nonzero entries in the global matrix.
virtual int NumGlobalRows () const
 Returns the number of global matrix rows.
virtual int NumGlobalCols () const
 Returns the number of global matrix columns.
virtual int NumGlobalDiagonals () const
 Returns the number of global nonzero diagonal entries, based on global row/column index comparisons.
virtual int NumMyNonzeros () const
 Returns the number of nonzero entries in the calling processor's portion of the matrix.
virtual int NumMyRows () const
 Returns the number of matrix rows owned by the calling processor.
virtual int NumMyCols () const
 Returns the number of matrix columns owned by the calling processor.
virtual int NumMyDiagonals () const
 Returns the number of local nonzero diagonal entries, based on global row/column index comparisons.
virtual bool LowerTriangular () const
 If matrix is lower triangular in local index space, this query returns true, otherwise it returns false.
virtual bool UpperTriangular () const
 If matrix is upper triangular in local index space, this query returns true, otherwise it returns false.
virtual const Epetra_MapRowMatrixRowMap () const
 Returns the Epetra_Map object associated with the rows of this matrix.
virtual const Epetra_MapRowMatrixColMap () const
 Returns the Epetra_Map object associated with the columns of this matrix.
virtual const Epetra_ImportRowMatrixImporter () const
 Returns the Epetra_Import object that contains the import operations for distributed operations.

Public Member Functions

int SetOwnership (bool ownership)
 Sets ownership.
int SetUseTranspose (bool UseTranspose)
 Sets use transpose (not implemented).
bool UseTranspose () const
 Returns the current UseTranspose setting.
bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator.
const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this operator.
const Epetra_BlockMapMap () const
const char * Label () const
int OverlapLevel () const
int ImportMultiVector (const Epetra_MultiVector &X, Epetra_MultiVector &OvX, Epetra_CombineMode CM=Insert)
int ExportMultiVector (const Epetra_MultiVector &OvX, Epetra_MultiVector &X, Epetra_CombineMode CM=Add)

Private Member Functions

const Epetra_RowMatrixA () const
Epetra_RowMatrixB () const

Private Attributes

int NumMyRows_
int NumMyCols_
int NumMyDiagonals_
int NumMyNonzeros_
int NumGlobalNonzeros_
int MaxNumEntries_
int NumMyRowsA_
int NumMyRowsB_
bool UseTranspose_
const Epetra_MapMap_
const Epetra_ImportImporter_
const Epetra_RowMatrixMatrix_
Epetra_CrsMatrixExtMatrix_
Epetra_MapExtMap_
Epetra_ImportExtImporter_
int OverlapLevel_
string Label_

Constructor & Destructor Documentation

Ifpack_OverlappingRowMatrix::Ifpack_OverlappingRowMatrix const Epetra_RowMatrix Matrix,
int  OverlapLevel
 

Constructors/Destructors.

Definition at line 12 of file Ifpack_OverlappingRowMatrix.cpp.

Ifpack_OverlappingRowMatrix::~Ifpack_OverlappingRowMatrix  ) 
 

Definition at line 134 of file Ifpack_OverlappingRowMatrix.cpp.


Member Function Documentation

int Ifpack_OverlappingRowMatrix::NumMyRowEntries int  MyRow,
int &  NumEntries
const [virtual]
 

Returns the number of nonzero entries in MyRow.

Parameters:
MyRow - (In) Local row.
NumEntries - (Out) Number of nonzero values present.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

Definition at line 150 of file Ifpack_OverlappingRowMatrix.cpp.

virtual int Ifpack_OverlappingRowMatrix::MaxNumEntries  )  const [inline, virtual]
 

Returns the maximum of NumMyRowEntries() over all rows.

Implements Epetra_RowMatrix.

Definition at line 38 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::ExtractMyRowCopy int  MyRow,
int  Length,
int &  NumEntries,
double *  Values,
int *  Indices
const [virtual]
 

Returns a copy of the specified local row in user-provided arrays.

Parameters:
MyRow - (In) Local row to extract.
Length - (In) Length of Values and Indices.
NumEntries - (Out) Number of nonzero entries extracted.
Values - (Out) Extracted values for this row.
Indices - (Out) Extracted global column indices for the corresponding values.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

Definition at line 160 of file Ifpack_OverlappingRowMatrix.cpp.

int Ifpack_OverlappingRowMatrix::ExtractDiagonalCopy Epetra_Vector Diagonal  )  const [virtual]
 

Returns a copy of the main diagonal in a user-provided vector.

Parameters:
Diagonal - (Out) Extracted main diagonal.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

Definition at line 175 of file Ifpack_OverlappingRowMatrix.cpp.

int Ifpack_OverlappingRowMatrix::Multiply bool  TransA,
const Epetra_MultiVector X,
Epetra_MultiVector Y
const [virtual]
 

Returns the result of a Epetra_RowMatrix multiplied by a Epetra_MultiVector X in Y.

Parameters:
TransA -(In) If true, multiply by the transpose of matrix, otherwise just use matrix.
X - (In) A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
Y -(Out) A Epetra_MultiVector of dimension NumVectorscontaining result.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

Definition at line 183 of file Ifpack_OverlappingRowMatrix.cpp.

virtual int Ifpack_OverlappingRowMatrix::Solve bool  Upper,
bool  Trans,
bool  UnitDiagonal,
const Epetra_MultiVector X,
Epetra_MultiVector Y
const [inline, virtual]
 

Returns result of a local-only solve using a triangular Epetra_RowMatrix with Epetra_MultiVectors X and Y (NOT IMPLEMENTED).

Implements Epetra_RowMatrix.

Definition at line 86 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::Apply const Epetra_MultiVector X,
Epetra_MultiVector Y
const [virtual]
 

Implements Epetra_Operator.

Definition at line 219 of file Ifpack_OverlappingRowMatrix.cpp.

int Ifpack_OverlappingRowMatrix::ApplyInverse const Epetra_MultiVector X,
Epetra_MultiVector Y
const [virtual]
 

Implements Epetra_Operator.

Definition at line 227 of file Ifpack_OverlappingRowMatrix.cpp.

virtual int Ifpack_OverlappingRowMatrix::InvRowSums Epetra_Vector x  )  const [inline, virtual]
 

Computes the sum of absolute values of the rows of the Epetra_RowMatrix, results returned in x (NOT IMPLEMENTED).

Implements Epetra_RowMatrix.

Definition at line 98 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::LeftScale const Epetra_Vector x  )  [inline, virtual]
 

Scales the Epetra_RowMatrix on the left with a Epetra_Vector x (NOT IMPLEMENTED).

Implements Epetra_RowMatrix.

Definition at line 104 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::InvColSums Epetra_Vector x  )  const [inline, virtual]
 

Computes the sum of absolute values of the columns of the Epetra_RowMatrix, results returned in x (NOT IMPLEMENTED).

Implements Epetra_RowMatrix.

Definition at line 110 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::RightScale const Epetra_Vector x  )  [inline, virtual]
 

Scales the Epetra_RowMatrix on the right with a Epetra_Vector x (NOT IMPLEMENTED).

Implements Epetra_RowMatrix.

Definition at line 117 of file Ifpack_OverlappingRowMatrix.h.

virtual bool Ifpack_OverlappingRowMatrix::Filled  )  const [inline, virtual]
 

If FillComplete() has been called, this query returns true, otherwise it returns false.

Implements Epetra_RowMatrix.

Definition at line 127 of file Ifpack_OverlappingRowMatrix.h.

virtual double Ifpack_OverlappingRowMatrix::NormInf  )  const [inline, virtual]
 

Returns the infinity norm of the global matrix.

Implements Epetra_RowMatrix.

Definition at line 136 of file Ifpack_OverlappingRowMatrix.h.

virtual double Ifpack_OverlappingRowMatrix::NormOne  )  const [inline, virtual]
 

Returns the one norm of the global matrix.

Implements Epetra_RowMatrix.

Definition at line 145 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumGlobalNonzeros  )  const [inline, virtual]
 

Returns the number of nonzero entries in the global matrix.

Implements Epetra_RowMatrix.

Definition at line 151 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumGlobalRows  )  const [inline, virtual]
 

Returns the number of global matrix rows.

Implements Epetra_RowMatrix.

Definition at line 157 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumGlobalCols  )  const [inline, virtual]
 

Returns the number of global matrix columns.

Implements Epetra_RowMatrix.

Definition at line 163 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumGlobalDiagonals  )  const [inline, virtual]
 

Returns the number of global nonzero diagonal entries, based on global row/column index comparisons.

Implements Epetra_RowMatrix.

Definition at line 169 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumMyNonzeros  )  const [inline, virtual]
 

Returns the number of nonzero entries in the calling processor's portion of the matrix.

Implements Epetra_RowMatrix.

Definition at line 175 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumMyRows  )  const [inline, virtual]
 

Returns the number of matrix rows owned by the calling processor.

Implements Epetra_RowMatrix.

Definition at line 181 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumMyCols  )  const [inline, virtual]
 

Returns the number of matrix columns owned by the calling processor.

Implements Epetra_RowMatrix.

Definition at line 187 of file Ifpack_OverlappingRowMatrix.h.

virtual int Ifpack_OverlappingRowMatrix::NumMyDiagonals  )  const [inline, virtual]
 

Returns the number of local nonzero diagonal entries, based on global row/column index comparisons.

Implements Epetra_RowMatrix.

Definition at line 193 of file Ifpack_OverlappingRowMatrix.h.

virtual bool Ifpack_OverlappingRowMatrix::LowerTriangular  )  const [inline, virtual]
 

If matrix is lower triangular in local index space, this query returns true, otherwise it returns false.

Implements Epetra_RowMatrix.

Definition at line 199 of file Ifpack_OverlappingRowMatrix.h.

virtual bool Ifpack_OverlappingRowMatrix::UpperTriangular  )  const [inline, virtual]
 

If matrix is upper triangular in local index space, this query returns true, otherwise it returns false.

Implements Epetra_RowMatrix.

Definition at line 205 of file Ifpack_OverlappingRowMatrix.h.

virtual const Epetra_Map& Ifpack_OverlappingRowMatrix::RowMatrixRowMap  )  const [inline, virtual]
 

Returns the Epetra_Map object associated with the rows of this matrix.

Implements Epetra_RowMatrix.

Definition at line 211 of file Ifpack_OverlappingRowMatrix.h.

virtual const Epetra_Map& Ifpack_OverlappingRowMatrix::RowMatrixColMap  )  const [inline, virtual]
 

Returns the Epetra_Map object associated with the columns of this matrix.

Implements Epetra_RowMatrix.

Definition at line 217 of file Ifpack_OverlappingRowMatrix.h.

virtual const Epetra_Import* Ifpack_OverlappingRowMatrix::RowMatrixImporter  )  const [inline, virtual]
 

Returns the Epetra_Import object that contains the import operations for distributed operations.

Implements Epetra_RowMatrix.

Definition at line 223 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::SetOwnership bool  ownership  )  [inline]
 

Sets ownership.

Definition at line 232 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::SetUseTranspose bool  UseTranspose  )  [inline, virtual]
 

Sets use transpose (not implemented).

Implements Epetra_Operator.

Definition at line 238 of file Ifpack_OverlappingRowMatrix.h.

bool Ifpack_OverlappingRowMatrix::UseTranspose  )  const [inline, virtual]
 

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 245 of file Ifpack_OverlappingRowMatrix.h.

bool Ifpack_OverlappingRowMatrix::HasNormInf  )  const [inline, virtual]
 

Returns true if the this object can provide an approximate Inf-norm, false otherwise.

Implements Epetra_Operator.

Definition at line 251 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_Comm& Ifpack_OverlappingRowMatrix::Comm  )  const [inline, virtual]
 

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

Implements Epetra_Operator.

Definition at line 257 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_Map& Ifpack_OverlappingRowMatrix::OperatorDomainMap  )  const [inline, virtual]
 

Returns the Epetra_Map object associated with the domain of this operator.

Implements Epetra_Operator.

Definition at line 263 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_Map& Ifpack_OverlappingRowMatrix::OperatorRangeMap  )  const [inline, virtual]
 

Returns the Epetra_Map object associated with the range of this operator.

Implements Epetra_Operator.

Definition at line 269 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_BlockMap & Ifpack_OverlappingRowMatrix::Map  )  const [virtual]
 

Implements Epetra_SrcDistObject.

Definition at line 239 of file Ifpack_OverlappingRowMatrix.cpp.

const char* Ifpack_OverlappingRowMatrix::Label  )  const [inline, virtual]
 

Implements Epetra_Operator.

Definition at line 277 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::OverlapLevel  )  const [inline]
 

Definition at line 281 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::ImportMultiVector const Epetra_MultiVector X,
Epetra_MultiVector OvX,
Epetra_CombineMode  CM = Insert
 

Definition at line 246 of file Ifpack_OverlappingRowMatrix.cpp.

int Ifpack_OverlappingRowMatrix::ExportMultiVector const Epetra_MultiVector OvX,
Epetra_MultiVector X,
Epetra_CombineMode  CM = Add
 

Definition at line 255 of file Ifpack_OverlappingRowMatrix.cpp.

const Epetra_RowMatrix& Ifpack_OverlappingRowMatrix::A  )  const [inline, private]
 

Definition at line 295 of file Ifpack_OverlappingRowMatrix.h.

Epetra_RowMatrix & Ifpack_OverlappingRowMatrix::B  )  const [inline, private]
 

Definition at line 233 of file Ifpack_OverlappingRowMatrix.cpp.


Member Data Documentation

int Ifpack_OverlappingRowMatrix::NumMyRows_ [private]
 

Definition at line 302 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::NumMyCols_ [private]
 

Definition at line 303 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::NumMyDiagonals_ [private]
 

Definition at line 304 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::NumMyNonzeros_ [private]
 

Definition at line 305 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::NumGlobalNonzeros_ [private]
 

Definition at line 307 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::MaxNumEntries_ [private]
 

Definition at line 308 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::NumMyRowsA_ [private]
 

Definition at line 310 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::NumMyRowsB_ [private]
 

Definition at line 311 of file Ifpack_OverlappingRowMatrix.h.

bool Ifpack_OverlappingRowMatrix::UseTranspose_ [private]
 

Definition at line 313 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_Map* Ifpack_OverlappingRowMatrix::Map_ [private]
 

Definition at line 315 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_Import* Ifpack_OverlappingRowMatrix::Importer_ [private]
 

Definition at line 316 of file Ifpack_OverlappingRowMatrix.h.

const Epetra_RowMatrix* Ifpack_OverlappingRowMatrix::Matrix_ [private]
 

Definition at line 318 of file Ifpack_OverlappingRowMatrix.h.

Epetra_CrsMatrix* Ifpack_OverlappingRowMatrix::ExtMatrix_ [private]
 

Definition at line 319 of file Ifpack_OverlappingRowMatrix.h.

Epetra_Map* Ifpack_OverlappingRowMatrix::ExtMap_ [private]
 

Definition at line 320 of file Ifpack_OverlappingRowMatrix.h.

Epetra_Import* Ifpack_OverlappingRowMatrix::ExtImporter_ [private]
 

Definition at line 321 of file Ifpack_OverlappingRowMatrix.h.

int Ifpack_OverlappingRowMatrix::OverlapLevel_ [private]
 

Definition at line 323 of file Ifpack_OverlappingRowMatrix.h.

string Ifpack_OverlappingRowMatrix::Label_ [private]
 

Definition at line 324 of file Ifpack_OverlappingRowMatrix.h.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:37:31 2008 for Ifpack Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1