Ifpack_ReorderFilter Class Reference

Ifpack_ReorderFilter: a class for light-weight reorder of local rows and columns of an Epetra_RowMatrix. More...

#include <Ifpack_ReorderFilter.h>

Inheritance diagram for Ifpack_ReorderFilter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Ifpack_ReorderFilter (const Teuchos::RefCountPtr< Epetra_RowMatrix > &Matrix_in, const Teuchos::RefCountPtr< Ifpack_Reordering > &Reordering_in)
 Ifpack_ReorderFilter (const Ifpack_ReorderFilter &RHS)
 Copy constructor.
virtual ~Ifpack_ReorderFilter ()
 Destructor.
Ifpack_ReorderFilteroperator= (const Ifpack_ReorderFilter &RHS)
 Operator assignment.
virtual int NumMyRowEntries (int MyRow, int &NumEntries) const
 Returns the number of local row entries.
virtual int MaxNumEntries () const
 Returns maximum num entries.
virtual int ExtractMyRowCopy (int MyRow, int Length, int &NumEntries, double *Values, int *Indices) const
virtual int ExtractDiagonalCopy (Epetra_Vector &Diagonal) const
 Extracts a copy of the diagonal of the reordered matrix.
virtual int Multiply (bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Multiplies multi-vector X with the reordered matrix, returns result in Y.
virtual int Solve (bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Solve, not implemented.
virtual int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Applies the reordered matrix to multi-vector X, returns the result in Y.
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Applies the inverse of this operator (not implemented).
virtual int InvRowSums (Epetra_Vector &x) const
 Inverse of row sums (not implemented).
virtual int LeftScale (const Epetra_Vector &x)
 Left scale of the matrix (not implemented).
virtual int InvColSums (Epetra_Vector &x) const
 Inverse of column sums (not implemented).
virtual int RightScale (const Epetra_Vector &x)
 Right scale of the matrix (not implemented).
virtual bool Filled () const
 Returns true is the matrix called FillComplete().
virtual double NormInf () const
 Returns the infinite-norm.
virtual double NormOne () const
 Returns the 1-norm.
virtual int NumGlobalNonzeros () const
 Returns the number of global nonzero elements.
virtual int NumGlobalRows () const
 Returns the number of global rows.
virtual int NumGlobalCols () const
 Returns the number of global columns.
virtual int NumGlobalDiagonals () const
 Returns the number of global diagonals.
virtual int NumMyNonzeros () const
 Returns the number of local nonzero elements.
virtual int NumMyRows () const
 Returns the number of local rows.
virtual int NumMyCols () const
 Returns the number of local columns.
virtual int NumMyDiagonals () const
 Returns the number of local diagonals.
virtual bool LowerTriangular () const
 Returns true is the reordered matrix is lower triangular.
virtual bool UpperTriangular () const
 Returns true is the reordered matrix is upper triangular.
virtual const Epetra_MapRowMatrixRowMap () const
 Returns the row matrix of the non-reordered matrix.
virtual const Epetra_MapRowMatrixColMap () const
 Returns the column matrix of the non-reordered matrix.
virtual const Epetra_ImportRowMatrixImporter () const
 Returns the importer of the non-reordered matrix.
int SetUseTranspose (bool UseTranspose_in)
 Sets the use of the transpose.
bool UseTranspose () const
 Returns true if the transpose of this matrix is used.
bool HasNormInf () const
 Returns true if this matrix has the infinite norm.
const Epetra_CommComm () const
 Returns the communicator.
const Epetra_MapOperatorDomainMap () const
 Returns the operator domain map of the non-reordered matrix.
const Epetra_MapOperatorRangeMap () const
 Returns the operator domain range of the non-reordered matrix.
const Epetra_BlockMapMap () const
 Returns the map of the non-reordered matrix.
const char * Label () const
 Returns the label of this object.
Teuchos::RefCountPtr
< Epetra_RowMatrix
Matrix () const
 Returns a reference-counted pointer to the internally stored pointer to Epetra_RowMatrix.
Teuchos::RefCountPtr
< Ifpack_Reordering
Reordering () const
 Returns a reference-counted pointer to the internally stored pointer to Ifpack_Reordering..

Private Attributes

Teuchos::RefCountPtr
< Epetra_RowMatrix
A_
 Pointer to the matrix to be preconditioned.
Teuchos::RefCountPtr
< Ifpack_Reordering
Reordering_
 Pointer to the reordering to be used (already constructed).
int NumMyRows_
 Number of local rows of A_.
int MaxNumEntries_
 Maximum number of entries in A_.
char Label_ [80]
 Label for this object.

Detailed Description

Ifpack_ReorderFilter: a class for light-weight reorder of local rows and columns of an Epetra_RowMatrix.

Class Ifpack_ReorderFilter enables a light-weight construction of reordered matrices.

This class is used in Ifpack_AdditiveSchwarz to reorder (if required by the user) the localized matrix. As the localized matrix is defined on a serial communicator only, all maps are trivial (as all elements reside on the same process). This class does not attemp to define properly reordered maps, hence it should not be used for distributed matrices.

To improve the performances of Ifpack_AdditiveSchwarz, some operations are not performed in the construction phase (like for instance the computation of the 1-norm and infinite-norm, of check whether the reordered matrix is lower/upper triangular or not).

Author:
Marzio Sala, SNL 9214.
Date:
Last modified: Oct-04.

Definition at line 68 of file Ifpack_ReorderFilter.h.


Constructor & Destructor Documentation

Ifpack_ReorderFilter::Ifpack_ReorderFilter ( const Teuchos::RefCountPtr< Epetra_RowMatrix > &  Matrix_in,
const Teuchos::RefCountPtr< Ifpack_Reordering > &  Reordering_in 
)

Definition at line 41 of file Ifpack_ReorderFilter.cpp.

Ifpack_ReorderFilter::Ifpack_ReorderFilter ( const Ifpack_ReorderFilter RHS  ) 

Copy constructor.

Definition at line 51 of file Ifpack_ReorderFilter.cpp.

virtual Ifpack_ReorderFilter::~Ifpack_ReorderFilter (  )  [inline, virtual]

Destructor.

Definition at line 79 of file Ifpack_ReorderFilter.h.


Member Function Documentation

Ifpack_ReorderFilter & Ifpack_ReorderFilter::operator= ( const Ifpack_ReorderFilter RHS  ) 

Operator assignment.

Definition at line 62 of file Ifpack_ReorderFilter.cpp.

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

Returns the number of local row entries.

Implements Epetra_RowMatrix.

Definition at line 85 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::MaxNumEntries (  )  const [inline, virtual]

Returns maximum num entries.

Implements Epetra_RowMatrix.

Definition at line 91 of file Ifpack_ReorderFilter.h.

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

Implements Epetra_RowMatrix.

Definition at line 79 of file Ifpack_ReorderFilter.cpp.

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

Extracts a copy of the diagonal of the reordered matrix.

Implements Epetra_RowMatrix.

Definition at line 98 of file Ifpack_ReorderFilter.cpp.

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

Multiplies multi-vector X with the reordered matrix, returns result in Y.

Implements Epetra_RowMatrix.

Definition at line 108 of file Ifpack_ReorderFilter.cpp.

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

Solve, not implemented.

Implements Epetra_RowMatrix.

Definition at line 127 of file Ifpack_ReorderFilter.cpp.

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

Applies the reordered matrix to multi-vector X, returns the result in Y.

Implements Epetra_Operator.

Definition at line 135 of file Ifpack_ReorderFilter.cpp.

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

Applies the inverse of this operator (not implemented).

Implements Epetra_Operator.

Definition at line 116 of file Ifpack_ReorderFilter.h.

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

Inverse of row sums (not implemented).

Implements Epetra_RowMatrix.

Definition at line 123 of file Ifpack_ReorderFilter.h.

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

Left scale of the matrix (not implemented).

Implements Epetra_RowMatrix.

Definition at line 129 of file Ifpack_ReorderFilter.h.

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

Inverse of column sums (not implemented).

Implements Epetra_RowMatrix.

Definition at line 135 of file Ifpack_ReorderFilter.h.

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

Right scale of the matrix (not implemented).

Implements Epetra_RowMatrix.

Definition at line 141 of file Ifpack_ReorderFilter.h.

virtual bool Ifpack_ReorderFilter::Filled (  )  const [inline, virtual]

Returns true is the matrix called FillComplete().

Implements Epetra_RowMatrix.

Definition at line 147 of file Ifpack_ReorderFilter.h.

virtual double Ifpack_ReorderFilter::NormInf (  )  const [inline, virtual]

Returns the infinite-norm.

Implements Epetra_RowMatrix.

Definition at line 153 of file Ifpack_ReorderFilter.h.

virtual double Ifpack_ReorderFilter::NormOne (  )  const [inline, virtual]

Returns the 1-norm.

Implements Epetra_RowMatrix.

Definition at line 159 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumGlobalNonzeros (  )  const [inline, virtual]

Returns the number of global nonzero elements.

Implements Epetra_RowMatrix.

Definition at line 165 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumGlobalRows (  )  const [inline, virtual]

Returns the number of global rows.

Implements Epetra_RowMatrix.

Definition at line 171 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumGlobalCols (  )  const [inline, virtual]

Returns the number of global columns.

Implements Epetra_RowMatrix.

Definition at line 177 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumGlobalDiagonals (  )  const [inline, virtual]

Returns the number of global diagonals.

Implements Epetra_RowMatrix.

Definition at line 183 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumMyNonzeros (  )  const [inline, virtual]

Returns the number of local nonzero elements.

Implements Epetra_RowMatrix.

Definition at line 189 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumMyRows (  )  const [inline, virtual]

Returns the number of local rows.

Implements Epetra_RowMatrix.

Definition at line 195 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumMyCols (  )  const [inline, virtual]

Returns the number of local columns.

Implements Epetra_RowMatrix.

Definition at line 201 of file Ifpack_ReorderFilter.h.

virtual int Ifpack_ReorderFilter::NumMyDiagonals (  )  const [inline, virtual]

Returns the number of local diagonals.

Implements Epetra_RowMatrix.

Definition at line 207 of file Ifpack_ReorderFilter.h.

virtual bool Ifpack_ReorderFilter::LowerTriangular (  )  const [inline, virtual]

Returns true is the reordered matrix is lower triangular.

Implements Epetra_RowMatrix.

Definition at line 213 of file Ifpack_ReorderFilter.h.

virtual bool Ifpack_ReorderFilter::UpperTriangular (  )  const [inline, virtual]

Returns true is the reordered matrix is upper triangular.

Implements Epetra_RowMatrix.

Definition at line 219 of file Ifpack_ReorderFilter.h.

virtual const Epetra_Map& Ifpack_ReorderFilter::RowMatrixRowMap (  )  const [inline, virtual]

Returns the row matrix of the non-reordered matrix.

Implements Epetra_RowMatrix.

Definition at line 225 of file Ifpack_ReorderFilter.h.

virtual const Epetra_Map& Ifpack_ReorderFilter::RowMatrixColMap (  )  const [inline, virtual]

Returns the column matrix of the non-reordered matrix.

Implements Epetra_RowMatrix.

Definition at line 231 of file Ifpack_ReorderFilter.h.

virtual const Epetra_Import* Ifpack_ReorderFilter::RowMatrixImporter (  )  const [inline, virtual]

Returns the importer of the non-reordered matrix.

Implements Epetra_RowMatrix.

Definition at line 237 of file Ifpack_ReorderFilter.h.

int Ifpack_ReorderFilter::SetUseTranspose ( bool  UseTranspose_in  )  [inline, virtual]

Sets the use of the transpose.

Implements Epetra_Operator.

Definition at line 243 of file Ifpack_ReorderFilter.h.

bool Ifpack_ReorderFilter::UseTranspose (  )  const [inline, virtual]

Returns true if the transpose of this matrix is used.

Implements Epetra_Operator.

Definition at line 249 of file Ifpack_ReorderFilter.h.

bool Ifpack_ReorderFilter::HasNormInf (  )  const [inline, virtual]

Returns true if this matrix has the infinite norm.

Implements Epetra_Operator.

Definition at line 255 of file Ifpack_ReorderFilter.h.

const Epetra_Comm& Ifpack_ReorderFilter::Comm (  )  const [inline, virtual]

Returns the communicator.

Implements Epetra_Operator.

Definition at line 261 of file Ifpack_ReorderFilter.h.

const Epetra_Map& Ifpack_ReorderFilter::OperatorDomainMap (  )  const [inline, virtual]

Returns the operator domain map of the non-reordered matrix.

Implements Epetra_Operator.

Definition at line 267 of file Ifpack_ReorderFilter.h.

const Epetra_Map& Ifpack_ReorderFilter::OperatorRangeMap (  )  const [inline, virtual]

Returns the operator domain range of the non-reordered matrix.

Implements Epetra_Operator.

Definition at line 273 of file Ifpack_ReorderFilter.h.

const Epetra_BlockMap& Ifpack_ReorderFilter::Map (  )  const [inline, virtual]

Returns the map of the non-reordered matrix.

Implements Epetra_SrcDistObject.

Definition at line 279 of file Ifpack_ReorderFilter.h.

const char* Ifpack_ReorderFilter::Label (  )  const [inline, virtual]

Returns the label of this object.

Implements Epetra_Operator.

Definition at line 285 of file Ifpack_ReorderFilter.h.

Teuchos::RefCountPtr<Epetra_RowMatrix> Ifpack_ReorderFilter::Matrix (  )  const [inline]

Returns a reference-counted pointer to the internally stored pointer to Epetra_RowMatrix.

Definition at line 290 of file Ifpack_ReorderFilter.h.

Teuchos::RefCountPtr<Ifpack_Reordering> Ifpack_ReorderFilter::Reordering (  )  const [inline]

Returns a reference-counted pointer to the internally stored pointer to Ifpack_Reordering..

Definition at line 295 of file Ifpack_ReorderFilter.h.


Member Data Documentation

Pointer to the matrix to be preconditioned.

Definition at line 302 of file Ifpack_ReorderFilter.h.

Pointer to the reordering to be used (already constructed).

Definition at line 304 of file Ifpack_ReorderFilter.h.

Number of local rows of A_.

Definition at line 307 of file Ifpack_ReorderFilter.h.

Maximum number of entries in A_.

Definition at line 309 of file Ifpack_ReorderFilter.h.

char Ifpack_ReorderFilter::Label_[80] [private]

Label for this object.

Definition at line 311 of file Ifpack_ReorderFilter.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:41 2011 for Ifpack Package Browser (Single Doxygen Collection) by  doxygen 1.6.3