EpetraExt Package Browser (Single Doxygen Collection)
Development
|
Epetra_PETScAIJMatrix: A class for constructing and using real-valued sparse compressed row matrices. More...
#include <EpetraExt_PETScAIJMatrix.h>
Private Types | |
enum | petscMatrixType { PETSC_SEQ_AIJ, PETSC_MPI_AIJ } |
Private Member Functions | |
int | GetRow (int Row) const |
Private Attributes | |
Mat | Amat_ |
double * | Values_ |
int * | Indices_ |
int | MaxNumEntries_ |
Epetra_SerialComm * | Comm_ |
Epetra_Map * | DomainMap_ |
Epetra_Map * | ColMap_ |
Epetra_Import * | Importer_ |
Epetra_MultiVector * | ImportVector_ |
double | NumGlobalNonzeros_ |
int | NumMyNonzeros_ |
int | NumMyRows_ |
int | NumGlobalRows_ |
int | NumMyCols_ |
int | PetscRowStart_ |
int | PetscRowEnd_ |
MatType | MatType_ |
double | NormInf_ |
double | NormOne_ |
Constructors/Destructor | |
Epetra_PETScAIJMatrix (Mat Amat) | |
Epetra_PETScAIJMatrix constructor. More... | |
virtual | ~Epetra_PETScAIJMatrix () |
Epetra_PETScAIJMatrix Destructor. More... | |
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. More... | |
int | ExtractDiagonalCopy (Epetra_Vector &Diagonal) const |
Returns a copy of the main diagonal in a user-provided vector. More... | |
Computational methods | |
int | Multiply (bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
Returns the result of a Epetra_PETScAIJMatrix multiplied by a Epetra_MultiVector X in Y. More... | |
int | Solve (bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
Returns the result of a Epetra_PETScAIJMatrix multiplied by a Epetra_MultiVector X in Y. More... | |
int | InvRowSums (Epetra_Vector &x) const |
Computes the sum of absolute values of the rows of the Epetra_PETScAIJMatrix, results returned in x. More... | |
int | LeftScale (const Epetra_Vector &x) |
Scales the Epetra_PETScAIJMatrix on the left with a Epetra_Vector x. More... | |
int | InvColSums (Epetra_Vector &x) const |
Computes the sum of absolute values of the columns of the Epetra_PETScAIJMatrix, results returned in x. More... | |
int | RightScale (const Epetra_Vector &x) |
Scales the Epetra_PETScAIJMatrix on the right with a Epetra_Vector x. More... | |
Matrix Properties Query Methods | |
bool | Filled () const |
If FillComplete() has been called, this query returns true, otherwise it returns false. More... | |
bool | LowerTriangular () const |
If matrix is lower triangular, this query returns true, otherwise it returns false. More... | |
bool | UpperTriangular () const |
If matrix is upper triangular, this query returns true, otherwise it returns false. More... | |
Attribute access functions | |
Mat | Amat () const |
Returns a pointer to the PETSc matrix used to create this object. More... | |
double | NormInf () const |
Returns the infinity norm of the global matrix. More... | |
double | NormOne () const |
Returns the one norm of the global matrix. More... | |
int | NumGlobalNonzeros () const |
Returns the number of nonzero entries in the global matrix. More... | |
int | NumGlobalRows () const |
Returns the number of global matrix rows. More... | |
int | NumGlobalCols () const |
Returns the number of global matrix columns. More... | |
int | NumGlobalDiagonals () const |
Returns the number of global nonzero diagonal entries. More... | |
long long | NumGlobalNonzeros64 () const |
Returns the number of nonzero entries in the global matrix. More... | |
long long | NumGlobalRows64 () const |
Returns the number of global matrix rows. More... | |
long long | NumGlobalCols64 () const |
Returns the number of global matrix columns. More... | |
long long | NumGlobalDiagonals64 () const |
Returns the number of global nonzero diagonal entries. More... | |
int | NumMyNonzeros () const |
Returns the number of nonzero entries in the calling processor's portion of the matrix. More... | |
int | NumMyRows () const |
Returns the number of matrix rows owned by the calling processor. More... | |
int | NumMyCols () const |
Returns the number of matrix columns owned by the calling processor. More... | |
int | NumMyDiagonals () const |
Returns the number of local nonzero diagonal entries. More... | |
const Epetra_Map & | OperatorDomainMap () const |
Returns the Epetra_Map object associated with the domain of this operator. More... | |
const Epetra_Map & | OperatorRangeMap () const |
Returns the Epetra_Map object associated with the range of this operator (same as domain). More... | |
const Epetra_BlockMap & | Map () const |
Implement the Epetra_SrcDistObjec::Map() function. More... | |
const Epetra_Map & | RowMatrixRowMap () const |
Returns the Row Map object needed for implementing Epetra_RowMatrix. More... | |
const Epetra_Map & | RowMatrixColMap () const |
Returns the Column Map object needed for implementing Epetra_RowMatrix. More... | |
virtual const Epetra_Import * | RowMatrixImporter () const |
Returns the Epetra_Import object that contains the import operations for distributed operations. More... | |
const Epetra_Comm & | Comm () const |
Returns a pointer to the Epetra_Comm communicator associated with this matrix. More... | |
I/O Methods | |
virtual void | Print (std::ostream &os) const |
Print method. More... | |
Additional methods required to support the Epetra_Operator interface | |
const char * | Label () const |
Returns a character string describing the operator. More... | |
int | SetUseTranspose (bool UseTranspose) |
If set true, transpose of this operator will be applied. More... | |
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. More... | |
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. More... | |
virtual bool | HasNormInf () const |
Returns true because this class can compute an Inf-norm. More... | |
virtual bool | UseTranspose () const |
Returns the current UseTranspose setting. More... | |
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. More... | |
int | MaxNumEntries () const |
Returns the maximum of NumMyRowEntries() over all rows. More... | |
Additional Inherited Members |
Epetra_PETScAIJMatrix: A class for constructing and using real-valued sparse compressed row matrices.
The Epetra_PETScAIJMatrix is a wrapper class for PETSc sequential or parallel AIJ matrices. It is derived from the Epetra_RowMatrix class, and so provides PETSc users access to Trilinos preconditioners. This class is lightweight, i.e., there are no deep copies of matrix data. Whenever possible, class methods utilize callbacks to native PETSc functions. Currently, only sequential and parallel point AIJ PETSc matrix types are supported.
Definition at line 87 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Enumerator | |
---|---|
PETSC_SEQ_AIJ | |
PETSC_MPI_AIJ |
Definition at line 415 of file EpetraExt_PETScAIJMatrix.h.
Epetra_PETScAIJMatrix::Epetra_PETScAIJMatrix | ( | Mat | Amat | ) |
Epetra_PETScAIJMatrix constructor.
Creates a Epetra_PETScAIJMatrix object by encapsulating an existing PETSc matrix.
In | Amat - A completely constructed PETSc SEQAIJ or MPIAIJ matrix. |
|
virtual |
Epetra_PETScAIJMatrix Destructor.
|
virtual |
Returns a copy of the specified local row in user-provided arrays.
In | MyRow - Local row to extract. |
In | Length - Length of Values and Indices. |
Out | NumEntries - Number of nonzero entries extracted. |
Out | Values - Extracted values for this row. |
Out | Indices - Extracted local column indices for the corresponding values. |
Implements Epetra_RowMatrix.
|
virtual |
Returns a copy of the main diagonal in a user-provided vector.
Out | Diagonal - Extracted main diagonal. |
Implements Epetra_RowMatrix.
|
virtual |
Returns the result of a Epetra_PETScAIJMatrix multiplied by a Epetra_MultiVector X in Y.
In | TransA -If true, multiply by the transpose of matrix, otherwise just use matrix. |
In | X - A Epetra_MultiVector of dimension NumVectors to multiply with matrix. |
Out | Y -A Epetra_MultiVector of dimension NumVectorscontaining result. |
Implements Epetra_RowMatrix.
|
virtual |
Returns the result of a Epetra_PETScAIJMatrix multiplied by a Epetra_MultiVector X in Y.
In | Upper -If true, solve Ux = y, otherwise solve Lx = y. |
In | Trans -If true, solve transpose problem. |
In | UnitDiagonal -If true, assume diagonal is unit (whether it's stored or not). |
In | X - A Epetra_MultiVector of dimension NumVectors to solve for. |
Out | Y -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_RowMatrix.
|
virtual |
Computes the sum of absolute values of the rows of the Epetra_PETScAIJMatrix, 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 \e 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.
Out | x -A Epetra_Vector containing the row sums of the this matrix. |
Implements Epetra_RowMatrix.
|
virtual |
Scales the Epetra_PETScAIJMatrix on the left with a Epetra_Vector x.
The \e 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.
In | x -A Epetra_Vector to solve for. |
Implements Epetra_RowMatrix.
|
virtual |
Computes the sum of absolute values of the columns of the Epetra_PETScAIJMatrix, 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 \e 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.
Out | x -A Epetra_Vector containing the column sums of the this matrix. |
Implements Epetra_RowMatrix.
|
virtual |
Scales the Epetra_PETScAIJMatrix on the right with a Epetra_Vector x.
The \e 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.
In | x -The Epetra_Vector used for scaling this. |
Implements Epetra_RowMatrix.
|
inlinevirtual |
If FillComplete() has been called, this query returns true, otherwise it returns false.
Implements Epetra_RowMatrix.
Definition at line 220 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
If matrix is lower triangular, this query returns true, otherwise it returns false.
Implements Epetra_RowMatrix.
Definition at line 223 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
If matrix is upper triangular, this query returns true, otherwise it returns false.
Implements Epetra_RowMatrix.
Definition at line 226 of file EpetraExt_PETScAIJMatrix.h.
|
inline |
Returns a pointer to the PETSc matrix used to create this object.
Definition at line 234 of file EpetraExt_PETScAIJMatrix.h.
|
virtual |
Returns the infinity norm of the global matrix.
Implements Epetra_RowMatrix.
|
virtual |
Returns the one norm of the global matrix.
Implements Epetra_RowMatrix.
|
inlinevirtual |
Returns the number of nonzero entries in the global matrix.
Implements Epetra_RowMatrix.
Definition at line 250 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of global matrix rows.
Implements Epetra_RowMatrix.
Definition at line 253 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of global matrix columns.
Implements Epetra_RowMatrix.
Definition at line 256 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of global nonzero diagonal entries.
Implements Epetra_RowMatrix.
Definition at line 259 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of nonzero entries in the global matrix.
Implements Epetra_RowMatrix.
Definition at line 262 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of global matrix rows.
Implements Epetra_RowMatrix.
Definition at line 265 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of global matrix columns.
Implements Epetra_RowMatrix.
Definition at line 268 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of global nonzero diagonal entries.
Implements Epetra_RowMatrix.
Definition at line 271 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of nonzero entries in the calling processor's portion of the matrix.
Implements Epetra_RowMatrix.
Definition at line 274 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of matrix rows owned by the calling processor.
Implements Epetra_RowMatrix.
Definition at line 277 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of matrix columns owned by the calling processor.
Implements Epetra_RowMatrix.
Definition at line 280 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the number of local nonzero diagonal entries.
Implements Epetra_RowMatrix.
Definition at line 283 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the Epetra_Map object associated with the domain of this operator.
Implements Epetra_Operator.
Definition at line 286 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the Epetra_Map object associated with the range of this operator (same as domain).
Implements Epetra_Operator.
Definition at line 289 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Implement the Epetra_SrcDistObjec::Map() function.
Implements Epetra_SrcDistObject.
Definition at line 292 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the Row Map object needed for implementing Epetra_RowMatrix.
Implements Epetra_RowMatrix.
Definition at line 295 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the Column Map object needed for implementing Epetra_RowMatrix.
Implements Epetra_RowMatrix.
Definition at line 298 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the Epetra_Import object that contains the import operations for distributed operations.
Implements Epetra_RowMatrix.
Definition at line 301 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns a pointer to the Epetra_Comm communicator associated with this matrix.
Implements Epetra_Operator.
Definition at line 304 of file EpetraExt_PETScAIJMatrix.h.
|
virtual |
Print method.
|
inlinevirtual |
Returns a character string describing the operator.
Implements Epetra_Operator.
Definition at line 319 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
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.
In | UseTranspose -If true, multiply by the transpose of operator, otherwise just use operator. |
Implements Epetra_Operator.
Definition at line 331 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.
In | X - A Epetra_MultiVector of dimension NumVectors to multiply with matrix. |
Out | Y -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_Operator.
Definition at line 343 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
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_PETScAIJMatrix::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.
In | X - A Epetra_MultiVector of dimension NumVectors to solve for. |
Out | Y -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_Operator.
Definition at line 360 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns true because this class can compute an Inf-norm.
Implements Epetra_Operator.
Definition at line 365 of file EpetraExt_PETScAIJMatrix.h.
|
inlinevirtual |
Returns the current UseTranspose setting.
Implements Epetra_Operator.
Definition at line 368 of file EpetraExt_PETScAIJMatrix.h.
|
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.
In | MyRow - Local row. |
Out | NumEntries - Number of nonzero values. |
Implements Epetra_RowMatrix.
|
virtual |
Returns the maximum of NumMyRowEntries() over all rows.
Implements Epetra_RowMatrix.
|
private |
|
private |
Definition at line 393 of file EpetraExt_PETScAIJMatrix.h.
|
mutableprivate |
Definition at line 394 of file EpetraExt_PETScAIJMatrix.h.
|
mutableprivate |
Definition at line 395 of file EpetraExt_PETScAIJMatrix.h.
|
mutableprivate |
Definition at line 396 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 401 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 403 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 404 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 405 of file EpetraExt_PETScAIJMatrix.h.
|
mutableprivate |
Definition at line 406 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 408 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 409 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 410 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 411 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 412 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 413 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 414 of file EpetraExt_PETScAIJMatrix.h.
|
private |
Definition at line 416 of file EpetraExt_PETScAIJMatrix.h.
|
mutableprivate |
Definition at line 417 of file EpetraExt_PETScAIJMatrix.h.
|
mutableprivate |
Definition at line 418 of file EpetraExt_PETScAIJMatrix.h.