Epetra Development
Epetra_MsrMatrix Class Reference

Epetra_MsrMatrix: A class for constructing and using real-valued double-precision sparse compressed row matrices. More...

#include <Epetra_MsrMatrix.h>

Inheritance diagram for Epetra_MsrMatrix:
Inheritance graph
[legend]
Collaboration diagram for Epetra_MsrMatrix:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Constructors/Destructor
 Epetra_MsrMatrix (int *proc_config, AZ_MATRIX *Amat)
 Epetra_MsrMatrix constuctor using existing Aztec DMSR matrix.
virtual ~Epetra_MsrMatrix ()
 Epetra_MsrMatrix Destructor.
Extraction methods
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.
int ExtractDiagonalCopy (Epetra_Vector &Diagonal) const
 Returns a copy of the main diagonal in a user-provided vector.
Computational methods
int Multiply (bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_MsrMatrix multiplied by a Epetra_MultiVector X in Y.
int Solve (bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_MsrMatrix multiplied by a Epetra_MultiVector X in Y.
int InvRowSums (Epetra_Vector &x) const
 Computes the sum of absolute values of the rows of the Epetra_MsrMatrix, results returned in x.
int LeftScale (const Epetra_Vector &x)
 Scales the Epetra_MsrMatrix on the left with a Epetra_Vector x.
int InvColSums (Epetra_Vector &x) const
 Computes the sum of absolute values of the columns of the Epetra_MsrMatrix, results returned in x.
int RightScale (const Epetra_Vector &x)
 Scales the Epetra_MsrMatrix on the right with a Epetra_Vector x.
Matrix Properties Query Methods
bool Filled () const
 If FillComplete() has been called, this query returns true, otherwise it returns false.
bool LowerTriangular () const
 If matrix is lower triangular, this query returns true, otherwise it returns false.
bool UpperTriangular () const
 If matrix is upper triangular, this query returns true, otherwise it returns false.
Attribute access functions
AZ_MATRIX * Amat () const
 Returns a pointer to the Aztec Msr matrix used to create this object.
double NormInf () const
 Returns the infinity norm of the global matrix.
double NormOne () const
 Returns the one norm of the global matrix.
int NumGlobalNonzeros () const
 Returns the number of nonzero entries in the global matrix.
int NumGlobalRows () const
 Returns the number of global matrix rows.
int NumGlobalCols () const
 Returns the number of global matrix columns.
int NumGlobalDiagonals () const
 Returns the number of global nonzero diagonal entries.
int NumMyNonzeros () const
 Returns the number of nonzero entries in the calling processor's portion of the matrix.
int NumMyRows () const
 Returns the number of matrix rows owned by the calling processor.
int NumMyCols () const
 Returns the number of matrix columns owned by the calling processor.
int NumMyDiagonals () const
 Returns the number of local nonzero diagonal entries.
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 (same as domain).
const Epetra_BlockMapMap () const
 Implement the Epetra_SrcDistObjec::Map() function.
const Epetra_MapRowMatrixRowMap () const
 Returns the Row Map object needed for implementing Epetra_RowMatrix.
const Epetra_MapRowMatrixColMap () const
 Returns the Column Map object needed for implementing Epetra_RowMatrix.
virtual const Epetra_ImportRowMatrixImporter () const
 Returns the Epetra_Import object that contains the import operations for distributed operations.
const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this matrix.
I/O Methods
virtual void Print (ostream &os) const
 Print method.
Additional methods required to support the Epetra_Operator interface
const char * Label () const
 Returns a character string describing the operator.
int SetUseTranspose (bool use_transpose)
 If set true, transpose of this operator will be applied.
int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.
int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.
virtual bool HasNormInf () const
 Returns true because this class can compute an Inf-norm.
virtual bool UseTranspose () const
 Returns the current UseTranspose setting.
Additional methods required to implement RowMatrix interface
int NumMyRowEntries (int MyRow, int &NumEntries) const
 Return the current number of values stored for the specified local row.
int MaxNumEntries () const
 Returns the maximum of NumMyRowEntries() over all rows.

Detailed Description

Epetra_MsrMatrix: A class for constructing and using real-valued double-precision sparse compressed row matrices.

The Epetra_MsrMatrix provides basic support for existing Aztec users who have an investment in the Aztec DMSR matrix format. A user may pass an existing Aztec DMSR matrix to the constructor for this class. The data from the DMSR matrix will not be copied. Thus, any changes the user makes to the DMSR matrix data will be reflected in the associated Epetra_MsrMatrix object.


Constructor & Destructor Documentation

Epetra_MsrMatrix::Epetra_MsrMatrix ( int *  proc_config,
AZ_MATRIX *  Amat 
)

Epetra_MsrMatrix constuctor using existing Aztec DMSR matrix.

Creates a Epetra_MsrMatrix object by encapsulating an existing Aztec DMSR matrix. The Aztec matrix must come in as an AZ_MATRIX pointer, and AZ_transform must have called. Also, the AZ_matrix_type must be AZ_MSR_MATRIX. (If the matrix is stored in Amat, this information is contained in Amat->data_org[AZ_matrix_type].)

Parameters:
InAmat - A completely constructed Aztec DMSR matrix.
Inproc_config - An Aztec array containing information about the parallel machine.

Member Function Documentation

int Epetra_MsrMatrix::Apply ( const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const [inline, virtual]

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.

Parameters:
InX - A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
OutY -A Epetra_MultiVector of dimension NumVectors containing result.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_Operator.

References Multiply(), and UseTranspose().

int Epetra_MsrMatrix::ApplyInverse ( const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const [inline, virtual]

Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.

In this implementation, we use several existing attributes to determine how virtual method ApplyInverse() should call the concrete method Solve(). We pass in the UpperTriangular(), the Epetra_MsrMatrix::UseTranspose(), and NoDiagonal() methods. The most notable warning is that if a matrix has no diagonal values we assume that there is an implicit unit diagonal that should be accounted for when doing a triangular solve.

Parameters:
InX - A Epetra_MultiVector of dimension NumVectors to solve for.
OutY -A Epetra_MultiVector of dimension NumVectors containing result.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_Operator.

int Epetra_MsrMatrix::ExtractDiagonalCopy ( Epetra_Vector Diagonal) const [virtual]

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

Parameters:
OutDiagonal - Extracted main diagonal.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::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:
InMyRow - Local row to extract.
InLength - Length of Values and Indices.
OutNumEntries - Number of nonzero entries extracted.
OutValues - Extracted values for this row.
OutIndices - Extracted global column indices for the corresponding values.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::InvColSums ( Epetra_Vector x) const [virtual]

Computes the sum of absolute values of the columns of the Epetra_MsrMatrix, results returned in x.

The vector x will return such that x[j] will contain the inverse of sum of the absolute values of the this matrix will be sca such that A(i,j) = x(j)*A(i,j) where i denotes the global row number of A and j denotes the global column number of A. Using the resulting vector from this function as input to RighttScale() will make the one norm of the resulting matrix exactly 1.

Parameters:
Outx -A Epetra_Vector containing the column sums of the this matrix.
Warning:
It is assumed that the distribution of x is the same as the rows of this.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::InvRowSums ( Epetra_Vector x) const [virtual]

Computes the sum of absolute values of the rows of the Epetra_MsrMatrix, results returned in x.

The vector x will return such that x[i] will contain the inverse of sum of the absolute values of the this matrix will be scaled such that A(i,j) = x(i)*A(i,j) where i denotes the global row number of A and j denotes the global column number of A. Using the resulting vector from this function as input to LeftScale() will make the infinity norm of the resulting matrix exactly 1.

Parameters:
Outx -A Epetra_Vector containing the row sums of the this matrix.
Warning:
It is assumed that the distribution of x is the same as the rows of this.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::LeftScale ( const Epetra_Vector x) [virtual]

Scales the Epetra_MsrMatrix on the left with a Epetra_Vector x.

The this matrix will be scaled such that A(i,j) = x(i)*A(i,j) where i denotes the row number of A and j denotes the column number of A.

Parameters:
Inx -A Epetra_Vector to solve for.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::Multiply ( bool  TransA,
const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const [virtual]

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

Parameters:
InTransA -If true, multiply by the transpose of matrix, otherwise just use matrix.
InX - A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
OutY -A Epetra_MultiVector of dimension NumVectorscontaining result.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

Referenced by Apply().

int Epetra_MsrMatrix::NumMyRowEntries ( int  MyRow,
int &  NumEntries 
) const [virtual]

Return the current number of values stored for the specified local row.

Similar to NumMyEntries() except NumEntries is returned as an argument and error checking is done on the input value MyRow.

Parameters:
InMyRow - Local row.
OutNumEntries - Number of nonzero values.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::RightScale ( const Epetra_Vector x) [virtual]

Scales the Epetra_MsrMatrix on the right with a Epetra_Vector x.

The this matrix will be scaled such that A(i,j) = x(j)*A(i,j) where i denotes the global row number of A and j denotes the global column number of A.

Parameters:
Inx -The Epetra_Vector used for scaling this.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.

int Epetra_MsrMatrix::SetUseTranspose ( bool  use_transpose) [inline, virtual]

If set true, transpose of this operator will be applied.

This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1.

Parameters:
Inuse_transpose -If true, multiply by the transpose of operator, otherwise just use operator.
Returns:
Returns -1 if use_transpose is true, because it is not supported.

Implements Epetra_Operator.

int Epetra_MsrMatrix::Solve ( bool  Upper,
bool  Trans,
bool  UnitDiagonal,
const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const [virtual]

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

Parameters:
InUpper -If true, solve Ux = y, otherwise solve Lx = y.
InTrans -If true, solve transpose problem.
InUnitDiagonal -If true, assume diagonal is unit (whether it's stored or not).
InX - A Epetra_MultiVector of dimension NumVectors to solve for.
OutY -A Epetra_MultiVector of dimension NumVectors containing result.
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_RowMatrix.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Enumerations Enumerator