All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions | Protected Attributes | Private Types
Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Xpetra-specific matrix class. More...

#include <Xpetra_Matrix.hpp>

Inheritance diagram for Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
Describable Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >

List of all members.

Public Types

typedef Scalar scalar_type
typedef LocalOrdinal local_ordinal_type
typedef GlobalOrdinal global_ordinal_type
typedef Node node_type

Public Member Functions

virtual const Teuchos::RCP
< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 		getMap () const =0
 Implements DistObject interface.
virtual void doImport (const Matrix &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
 Import.
virtual void doExport (const Matrix &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
 Export.
virtual void doImport (const Matrix &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0
 Import (using an Exporter).
virtual void doExport (const Matrix &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0
 Export (using an Importer).
virtual RCP< const CrsGraph > getCrsGraph () const =0
 Returns the CrsGraph associated with this matrix.
void SetFixedBlockSize (LocalOrdinal blksize)
LocalOrdinal GetFixedBlockSize () const
virtual void SetMaxEigenvalueEstimate (Scalar const &sigma)
virtual Scalar GetMaxEigenvalueEstimate () const

Protected Attributes

Teuchos::Hashtable
< viewLabel_t, RCP< MatrixView > > 		operatorViewTable_
viewLabel_t defaultViewLabel_
viewLabel_t currentViewLabel_

Private Types

typedef Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > 		Map
typedef Xpetra::CrsMatrix
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > 		CrsMatrix
typedef Xpetra::CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > 		CrsGraph
typedef
Xpetra::TpetraCrsMatrix
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > 		TpetraCrsMatrix
typedef
Xpetra::CrsMatrixFactory
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > 		CrsMatrixFactory
typedef Xpetra::MatrixView
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > 		MatrixView

Constructor/Destructor Methods

 Matrix ()
virtual ~Matrix ()
 Destructor.

View management methods

void CreateView (viewLabel_t viewLabel, const RCP< const Map > &rowMap, const RCP< const Map > &colMap)
void CreateView (const viewLabel_t viewLabel, const RCP< const Matrix > &A, bool transposeA=false, const RCP< const Matrix > &B=Teuchos::null, bool transposeB=false)
void PrintViews (Teuchos::FancyOStream &out) const
 Print all of the views associated with the Matrix.
void RemoveView (const viewLabel_t viewLabel)
const viewLabel_t SwitchToView (const viewLabel_t viewLabel)
bool IsView (const viewLabel_t viewLabel) const
const viewLabel_t SwitchToDefaultView ()
const viewLabel_t & GetDefaultViewLabel () const
const viewLabel_t & GetCurrentViewLabel () const

Insertion/Removal Methods

virtual void insertGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
 Insert matrix entries, using global IDs.
virtual void insertLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
 Insert matrix entries, using local IDs.
virtual void replaceGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
 Replace matrix entries, using global IDs.
virtual void replaceLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
 Replace matrix entries, using local IDs.
virtual void setAllToScalar (const Scalar &alpha)=0
 Set all matrix entries equal to scalar.
virtual void scale (const Scalar &alpha)=0
 Scale the current values of a matrix, this = alpha*this.

Transformational Methods

virtual void resumeFill (const RCP< ParameterList > &params=null)=0
virtual void fillComplete (const RCP< const Map > &domainMap, const RCP< const Map > &rangeMap, const RCP< ParameterList > &params=null)=0
 Signal that data entry is complete, specifying domain and range maps.
virtual void fillComplete (const RCP< ParameterList > &params=null)=0
 Signal that data entry is complete.

Methods implementing RowMatrix

virtual const RCP< const Map > & getRowMap () const
 Returns the Map that describes the row distribution in this matrix.
virtual const RCP< const Map > & getRowMap (viewLabel_t viewLabel) const
 Returns the Map that describes the row distribution in this matrix.
virtual const RCP< const Map > & getColMap () const
 Returns the Map that describes the column distribution in this matrix. This might be null until fillComplete() is called.
virtual const RCP< const Map > & getColMap (viewLabel_t viewLabel) const
 Returns the Map that describes the column distribution in this matrix.
virtual global_size_t getGlobalNumRows () const =0
 Returns the number of global rows in this matrix.
virtual global_size_t getGlobalNumCols () const =0
 Returns the number of global columns in the matrix.
virtual size_t getNodeNumRows () const =0
 Returns the number of matrix rows owned on the calling node.
virtual global_size_t getGlobalNumEntries () const =0
 Returns the global number of entries in this matrix.
virtual size_t getNodeNumEntries () const =0
 Returns the local number of entries in this matrix.
virtual size_t getNumEntriesInLocalRow (LocalOrdinal localRow) const =0
 Returns the current number of entries on this node in the specified local row.
virtual global_size_t getGlobalNumDiags () const =0
 Returns the number of global diagonal entries, based on global row/column index comparisons.
virtual size_t getNodeNumDiags () const =0
 Returns the number of local diagonal entries, based on global row/column index comparisons.
virtual size_t getGlobalMaxNumRowEntries () const =0
 Returns the maximum number of entries across all rows/columns on all nodes.
virtual size_t getNodeMaxNumRowEntries () const =0
 Returns the maximum number of entries across all rows/columns on this node.
virtual bool isLocallyIndexed () const =0
 If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. */.
virtual bool isGloballyIndexed () const =0
 If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. */.
virtual bool isFillComplete () const =0
 Returns true if fillComplete() has been called and the matrix is in compute mode.
virtual void getLocalRowCopy (LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const =0
 Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calling routine.
virtual void getGlobalRowView (GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
 Extract a const, non-persisting view of global indices in a specified row of the matrix.
virtual void getLocalRowView (LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
 Extract a const, non-persisting view of local indices in a specified row of the matrix.
virtual void getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const =0
 Get a copy of the diagonal entries owned by this node, with local row idices.
virtual ScalarTraits< Scalar >
::magnitudeType 		getFrobeniusNorm () const =0
 Get Frobenius norm of the matrix.

Methods implementing Matrix

Multiplies this matrix by a MultiVector.

X is required to be post-imported, i.e., described by the column map of the matrix. Y is required to be pre-exported, i.e., described by the row map of the matrix.

Both are required to have constant stride, and they are not permitted to ocupy overlapping space. No runtime checking will be performed in a non-debug build.

This method is templated on the scalar type of MultiVector objects, allowing this method to be applied to MultiVector objects of arbitrary type. However, it is recommended that multiply() not be called directly; instead, use the CrsMatrixMultiplyOp, as it will handle the import/exprt operations required to apply a matrix with non-trivial communication needs.

If beta is equal to zero, the operation will enjoy overwrite semantics (Y will be overwritten with the result of the multiplication). Otherwise, the result of the multiplication will be accumulated into Y.

virtual void apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const =0
 Computes the sparse matrix-multivector multiplication.
virtual const RCP< const
Xpetra::Map< LocalOrdinal,
GlobalOrdinal, Node > > 		getDomainMap () const =0
 Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.
virtual const RCP< const
Xpetra::Map< LocalOrdinal,
GlobalOrdinal, Node > > 		getRangeMap () const =0
virtual void removeEmptyProcessesInPlace (const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &newMap)=0

Overridden from Teuchos::Describable

Return a simple one-line description of this object.

Print the object with some verbosity level to an FancyOStream object.

virtual std::string description () const =0
 Return a simple one-line description of this object.
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
 Print the object with some verbosity level to an FancyOStream object.

Detailed Description

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Xpetra-specific matrix class.

This class is specific to Xpetra and has no analogue in Epetra or Tpetra. The main motivation for this class is to be able to access matrix data in a manner different than how it is stored. For example, it might be more convenient to treat ("view") a matrix stored in compressed row storage as if it were a block matrix. The Xpetra::Matrix class is intended to manage these "views".

How to create a Matrix from an existing CrsMatrix

     RCP<Xpetra::CrsMatrix> crsA;
     RCP<Xpetra::Matrix>    A  = rcp(new CrsMatrixWrap(crsA));

Definition at line 98 of file Xpetra_Matrix.hpp.

Member Typedef Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map [private]

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 99 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrix [private]

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 100 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsGraph [private]

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 101 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraCrsMatrix [private]

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 103 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::CrsMatrixFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixFactory [private]

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 105 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::MatrixView<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatrixView [private]

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 106 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Scalar Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Reimplemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 109 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef LocalOrdinal Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Reimplemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 110 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef GlobalOrdinal Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Reimplemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 111 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Node Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Reimplemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 112 of file Xpetra_Matrix.hpp.

Constructor & Destructor Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Matrix ( ) [inline]

Definition at line 117 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~Matrix ( ) [inline, virtual]

Destructor.

Definition at line 120 of file Xpetra_Matrix.hpp.

Member Function Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CreateView ( viewLabel_t  viewLabel,
const RCP< const Map > &  rowMap,
const RCP< const Map > &  colMap 
) [inline]

Definition at line 126 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CreateView ( const viewLabel_t  viewLabel,
const RCP< const Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  A,
bool  transposeA = false,
const RCP< const Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  B = Teuchos::null,
bool  transposeB = false 
) [inline]

Definition at line 133 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::PrintViews ( Teuchos::FancyOStream &  out) const [inline]

Print all of the views associated with the Matrix.

Definition at line 180 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RemoveView ( const viewLabel_t  viewLabel) [inline]

Definition at line 194 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
const viewLabel_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SwitchToView ( const viewLabel_t  viewLabel) [inline]

Definition at line 200 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
bool Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::IsView ( const viewLabel_t  viewLabel) const [inline]

Definition at line 207 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
const viewLabel_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SwitchToDefaultView ( ) [inline]

Definition at line 211 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
const viewLabel_t& Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDefaultViewLabel ( ) const [inline]

Definition at line 213 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
const viewLabel_t& Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetCurrentViewLabel ( ) const [inline]

Definition at line 215 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::insertGlobalValues ( GlobalOrdinal  globalRow,
const ArrayView< const GlobalOrdinal > &  cols,
const ArrayView< const Scalar > &  vals 
) [pure virtual]

Insert matrix entries, using global IDs.

All index values must be in the global space.

Precondition:
globalRow exists as an ID in the global row map
isLocallyIndexed() == false
isStorageOptimized() == false
Postcondition:
isGloballyIndexed() == true
Note:
If globalRow does not belong to the matrix on this node, then it will be communicated to the appropriate node when globalAssemble() is called (which will, at the latest, occur during the next call to fillComplete().) Otherwise, the entries will be inserted in the local matrix.
If the matrix row already contains values at the indices corresponding to values in cols, then the new values will be summed with the old values; this may happen at insertion or during the next call to fillComplete().
If hasColMap() == true, only (cols[i],vals[i]) where cols[i] belongs to the column map on this node will be inserted into the matrix.

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::insertLocalValues ( LocalOrdinal  localRow,
const ArrayView< const LocalOrdinal > &  cols,
const ArrayView< const Scalar > &  vals 
) [pure virtual]

Insert matrix entries, using local IDs.

All index values must be in the local space.

Precondition:
localRow exists as an ID in the local row map
isGloballyIndexed() == false
isStorageOptimized() == false
Postcondition:
isLocallyIndexed() == true

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValues ( GlobalOrdinal  globalRow,
const ArrayView< const GlobalOrdinal > &  cols,
const ArrayView< const Scalar > &  vals 
) [pure virtual]

Replace matrix entries, using global IDs.

All index values must be in the global space.

Precondition:
globalRow is a global row belonging to the matrix on this node.
Note:
If (globalRow,cols[i]) corresponds to an entry that is duplicated in this matrix row (likely because it was inserted more than once and fillComplete() has not been called in the interim), the behavior of this function is not defined.

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValues ( LocalOrdinal  localRow,
const ArrayView< const LocalOrdinal > &  cols,
const ArrayView< const Scalar > &  vals 
) [pure virtual]

Replace matrix entries, using local IDs.

All index values must be in the local space. Note that if a value is not already present for the specified location in the matrix, the input value will be ignored silently.

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setAllToScalar ( const Scalar &  alpha) [pure virtual]

Set all matrix entries equal to scalar.

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( const Scalar &  alpha) [pure virtual]

Scale the current values of a matrix, this = alpha*this.

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::resumeFill ( const RCP< ParameterList > &  params = null) [pure virtual]

Resume fill operations. After calling fillComplete(), resumeFill() must be called before initiating any changes to the matrix.

resumeFill() may be called repeatedly.

Postcondition:
isFillActive() == true
isFillComplete() == false

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::fillComplete ( const RCP< const Map > &  domainMap,
const RCP< const Map > &  rangeMap,
const RCP< ParameterList > &  params = null 
) [pure virtual]

Signal that data entry is complete, specifying domain and range maps.

Off-node indices are distributed (via globalAssemble()), indices are sorted, redundant indices are eliminated, and global indices are transformed to local indices.

Precondition:
isFillActive() == true
isFillComplete()() == false
Postcondition:
isFillActive() == false
isFillComplete() == true
if os == DoOptimizeStorage, then isStorageOptimized() == true

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::fillComplete ( const RCP< ParameterList > &  params = null) [pure virtual]

Signal that data entry is complete.

Off-node entries are distributed (via globalAssemble()), repeated entries are summed, and global indices are transformed to local indices.

Note:
This method calls fillComplete( getRowMap(), getRowMap(), os ).
Precondition:
isFillActive() == true
isFillComplete()() == false
Postcondition:
isFillActive() == false
isFillComplete() == true
if os == DoOptimizeStorage, then isStorageOptimized() == true

Implemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const RCP<const Map>& Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRowMap ( ) const [inline, virtual]

Returns the Map that describes the row distribution in this matrix.

Definition at line 320 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const RCP<const Map>& Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRowMap ( viewLabel_t  viewLabel) const [inline, virtual]

Returns the Map that describes the row distribution in this matrix.

Definition at line 323 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const RCP<const Map>& Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getColMap ( ) const [inline, virtual]

Returns the Map that describes the column distribution in this matrix. This might be null until fillComplete() is called.

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 330 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const RCP<const Map>& Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getColMap ( viewLabel_t  viewLabel) const [inline, virtual]

Returns the Map that describes the column distribution in this matrix.

Reimplemented in Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 333 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual global_size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const [pure virtual]

Returns the number of global rows in this matrix.

Undefined if isFillActive().

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual global_size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const [pure virtual]

Returns the number of global columns in the matrix.

Undefined if isFillActive().

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeNumRows ( ) const [pure virtual]

Returns the number of matrix rows owned on the calling node.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual global_size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const [pure virtual]

Returns the global number of entries in this matrix.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeNumEntries ( ) const [pure virtual]

Returns the local number of entries in this matrix.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInLocalRow ( LocalOrdinal  localRow) const [pure virtual]

Returns the current number of entries on this node in the specified local row.

Returns OrdinalTraits<size_t>::invalid() if the specified local row is not valid for this matrix.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual global_size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumDiags ( ) const [pure virtual]

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

Undefined if isFillActive().

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeNumDiags ( ) const [pure virtual]

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

Undefined if isFillActive().

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalMaxNumRowEntries ( ) const [pure virtual]

Returns the maximum number of entries across all rows/columns on all nodes.

Undefined if isFillActive().

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const [pure virtual]

Returns the maximum number of entries across all rows/columns on this node.

Undefined if isFillActive().

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual bool Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isLocallyIndexed ( ) const [pure virtual]

If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. */.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual bool Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isGloballyIndexed ( ) const [pure virtual]

If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. */.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual bool Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isFillComplete ( ) const [pure virtual]

Returns true if fillComplete() has been called and the matrix is in compute mode.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalRowCopy ( LocalOrdinal  LocalRow,
const ArrayView< LocalOrdinal > &  Indices,
const ArrayView< Scalar > &  Values,
size_t &  NumEntries 
) const [pure virtual]

Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calling routine.

Parameters:
LocalRow- (In) Local row number for which indices are desired.
Indices- (Out) Local column indices corresponding to values.
Values- (Out) Matrix values.
NumIndices- (Out) Number of indices.

Note: A std::runtime_error exception is thrown if either Indices or Values is not large enough to hold the data associated with row LocalRow. If LocalRow is not valid for this node, then Indices and Values are unchanged and NumIndices is returned as OrdinalTraits<size_t>::invalid().

Precondition:
isLocallyIndexed()==true or hasColMap() == true

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalRowView ( GlobalOrdinal  GlobalRow,
ArrayView< const GlobalOrdinal > &  indices,
ArrayView< const Scalar > &  values 
) const [pure virtual]

Extract a const, non-persisting view of global indices in a specified row of the matrix.

Parameters:
GlobalRow- (In) Global row number for which indices are desired.
Indices- (Out) Global column indices corresponding to values.
Values- (Out) Row values
Precondition:
isLocallyIndexed() == false
Postcondition:
indices.size() == getNumEntriesInGlobalRow(GlobalRow)

Note: If GlobalRow does not belong to this node, then indices is set to null.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalRowView ( LocalOrdinal  LocalRow,
ArrayView< const LocalOrdinal > &  indices,
ArrayView< const Scalar > &  values 
) const [pure virtual]

Extract a const, non-persisting view of local indices in a specified row of the matrix.

Parameters:
LocalRow- (In) Local row number for which indices are desired.
Indices- (Out) Global column indices corresponding to values.
Values- (Out) Row values
Precondition:
isGloballyIndexed() == false
Postcondition:
indices.size() == getNumEntriesInLocalRow(LocalRow)

Note: If LocalRow does not belong to this node, then indices is set to null.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalDiagCopy ( Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  diag) const [pure virtual]

Get a copy of the diagonal entries owned by this node, with local row idices.

Returns a distributed Vector object partitioned according to this matrix's row map, containing the the zero and non-zero diagonals owned by this node.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual ScalarTraits<Scalar>::magnitudeType Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getFrobeniusNorm ( ) const [pure virtual]

Get Frobenius norm of the matrix.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::apply ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  X,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
Scalar  alpha = ScalarTraits< Scalar >::one(),
Scalar  beta = ScalarTraits< Scalar >::zero() 
) const [pure virtual]

Computes the sparse matrix-multivector multiplication.

Performs $Y = \alpha A^{\textrm{mode}} X + \beta Y$, with one special exceptions:

  • if beta == 0, apply() overwrites Y, so that any values in Y (including NaNs) are ignored.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const RCP<const Xpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const [pure virtual]

Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const RCP<const Xpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const [pure virtual]

Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::removeEmptyProcessesInPlace ( const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &  newMap) [pure virtual]
template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const [pure virtual]

Implements DistObject interface.

Access function for the Tpetra::Map this DistObject was constructed with.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport ( const Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  source,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  importer,
CombineMode  CM 
) [pure virtual]

Import.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport ( const Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  dest,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  importer,
CombineMode  CM 
) [pure virtual]

Export.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport ( const Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  source,
const Export< LocalOrdinal, GlobalOrdinal, Node > &  exporter,
CombineMode  CM 
) [pure virtual]

Import (using an Exporter).

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport ( const Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  dest,
const Export< LocalOrdinal, GlobalOrdinal, Node > &  exporter,
CombineMode  CM 
) [pure virtual]

Export (using an Importer).

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual std::string Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const [pure virtual]

Return a simple one-line description of this object.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const [pure virtual]

Print the object with some verbosity level to an FancyOStream object.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual RCP<const CrsGraph> Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getCrsGraph ( ) const [pure virtual]

Returns the CrsGraph associated with this matrix.

Implemented in Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetFixedBlockSize ( LocalOrdinal  blksize) [inline]

Definition at line 543 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
LocalOrdinal Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetFixedBlockSize ( ) const [inline]

Definition at line 568 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetMaxEigenvalueEstimate ( Scalar const &  sigma) [inline, virtual]

Definition at line 583 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Scalar Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetMaxEigenvalueEstimate ( ) const [inline, virtual]

Definition at line 589 of file Xpetra_Matrix.hpp.

Member Data Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::Hashtable<viewLabel_t, RCP<MatrixView> > Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::operatorViewTable_ [protected]

Definition at line 596 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
viewLabel_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::defaultViewLabel_ [protected]

Definition at line 598 of file Xpetra_Matrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
viewLabel_t Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::currentViewLabel_ [protected]

Definition at line 599 of file Xpetra_Matrix.hpp.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated on Wed Mar 18 2015 22:49:38 for Xpetra by   doxygen 1.7.6.1