Tpetra Matrix/Vector Services Version of the Day
Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

A pure virtual interface for row-partitioned graphs. More...

#include <Tpetra_RowGraph.hpp>

Inheritance diagram for Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Destructor Method
virtual ~RowGraph ()
 Destructor.
Graph Query Methods
virtual const Teuchos::RCP
< const Teuchos::Comm< int > > & 
getComm () const =0
 Returns the communicator.
virtual Teuchos::RCP< Node > getNode () const =0
 Returns the underlying node.
virtual const Teuchos::RCP
< const Map< LocalOrdinal,
GlobalOrdinal, Node > > & 
getRowMap () const =0
 Returns the Map that describes the row distribution in this graph.
virtual const Teuchos::RCP
< const Map< LocalOrdinal,
GlobalOrdinal, Node > > & 
getColMap () const =0
 Returns the Map that describes the column distribution in this graph.
virtual const Teuchos::RCP
< const Map< LocalOrdinal,
GlobalOrdinal, Node > > & 
getDomainMap () const =0
 Returns the Map associated with the domain of this graph.
virtual const Teuchos::RCP
< const Map< LocalOrdinal,
GlobalOrdinal, Node > > & 
getRangeMap () const =0
 Returns the Map associated with the domain of this graph.
virtual Teuchos::RCP< const
Import< LocalOrdinal,
GlobalOrdinal, Node > > 
getImporter () const =0
 Returns the importer associated with this graph.
virtual Teuchos::RCP< const
Export< LocalOrdinal,
GlobalOrdinal, Node > > 
getExporter () const =0
 Returns the exporter associated with this graph.
virtual global_size_t getGlobalNumRows () const =0
 Returns the number of global rows in the graph.
virtual global_size_t getGlobalNumCols () const =0
 Returns the number of global columns in the graph.
virtual size_t getNodeNumRows () const =0
 Returns the number of rows owned on the calling node.
virtual size_t getNodeNumCols () const =0
 Returns the number of columns connected to the locally owned rows of this graph.
virtual GlobalOrdinal getIndexBase () const =0
 Returns the index base for global indices for this graph.
virtual global_size_t getGlobalNumEntries () const =0
 Returns the global number of entries in the graph.
virtual size_t getNodeNumEntries () const =0
 Returns the local number of entries in the graph.
virtual size_t getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const =0
 Returns the current number of entries on this node in the specified global row.
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 hasColMap () const =0
 Indicates whether the graph has a well-defined column map.
virtual bool isLowerTriangular () const =0
 Indicates whether the graph is lower triangular.
virtual bool isUpperTriangular () const =0
 Indicates whether the graph is upper triangular.
virtual bool isLocallyIndexed () const =0
 If graph indices are in the local range, this function returns true. Otherwise, this function returns false. */.
virtual bool isGloballyIndexed () const =0
 If graph 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.
Extraction Methods
virtual void getGlobalRowCopy (GlobalOrdinal GlobalRow, const Teuchos::ArrayView< GlobalOrdinal > &Indices, size_t &NumIndices) const =0
 Extract a list of entries in a specified global row of the graph. Put into pre-allocated storage.
virtual void getLocalRowCopy (LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, size_t &NumIndices) const =0
 Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine.

Detailed Description

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
class Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >

A pure virtual interface for row-partitioned graphs.

This class is templated on LocalOrdinal, GlobalOrdinal and Node. The LocalOrdinal type, if omitted, defaults to int. The GlobalOrdinal type defaults to the LocalOrdinal type. The Node type defaults to the default node in Kokkos.

Definition at line 64 of file Tpetra_RowGraph.hpp.


Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::~RowGraph ( ) [virtual]

Destructor.

Definition at line 202 of file Tpetra_RowGraph.hpp.


Member Function Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual const Teuchos::RCP<const Teuchos::Comm<int> >& Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const [pure virtual]

Returns the communicator.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP<Node> Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNode ( ) const [pure virtual]

Returns the underlying node.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getRowMap ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getColMap ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const [pure virtual]

Returns the Map associated with the domain of this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const [pure virtual]

Returns the Map associated with the domain of this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP<const Import<LocalOrdinal,GlobalOrdinal,Node> > Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getImporter ( ) const [pure virtual]

Returns the importer associated with this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP<const Export<LocalOrdinal,GlobalOrdinal,Node> > Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getExporter ( ) const [pure virtual]

Returns the exporter associated with this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual global_size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const [pure virtual]

Returns the number of global rows in the graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual global_size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const [pure virtual]

Returns the number of global columns in the graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumRows ( ) const [pure virtual]

Returns the number of rows owned on the calling node.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumCols ( ) const [pure virtual]

Returns the number of columns connected to the locally owned rows of this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const [pure virtual]

Returns the index base for global indices for this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual global_size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const [pure virtual]

Returns the global number of entries in the graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumEntries ( ) const [pure virtual]

Returns the local number of entries in the graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInGlobalRow ( GlobalOrdinal  globalRow) const [pure virtual]

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

Returns Teuchos::OrdinalTraits<size_t>::invalid() if the specified global row does not belong to this graph.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInLocalRow ( LocalOrdinal  localRow) const [pure virtual]

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

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual global_size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumDiags ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumDiags ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalMaxNumRowEntries ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual size_t Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual bool Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::hasColMap ( ) const [pure virtual]

Indicates whether the graph has a well-defined column map.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual bool Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isLowerTriangular ( ) const [pure virtual]

Indicates whether the graph is lower triangular.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual bool Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isUpperTriangular ( ) const [pure virtual]

Indicates whether the graph is upper triangular.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual bool Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isLocallyIndexed ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual bool Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isGloballyIndexed ( ) const [pure virtual]

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual bool Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isFillComplete ( ) const [pure virtual]

Returns true if fillComplete() has been called.

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual void Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalRowCopy ( GlobalOrdinal  GlobalRow,
const Teuchos::ArrayView< GlobalOrdinal > &  Indices,
size_t &  NumIndices 
) const [pure virtual]

Extract a list of entries in a specified global row of the graph. Put into pre-allocated storage.

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

Note: A std::runtime_error exception is thrown if Indices is not large enough to hold the column indices associated with row GlobalRow. If GlobalRow does not belong to this node, then Indices is unchanged and NumIndices is returned as Teuchos::OrdinalTraits<size_t>::invalid().

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual void Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getLocalRowCopy ( LocalOrdinal  LocalRow,
const Teuchos::ArrayView< LocalOrdinal > &  Indices,
size_t &  NumIndices 
) const [pure virtual]

Extract a list of entries in a specified local row of the graph. 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.
NumIndices- (Out) Number of indices.

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

Implemented in Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node, LocalMatOps >.


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