All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types
Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_RowGraph.hpp>

Inheritance diagram for Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >:
Describable

List of all members.

Public Types

typedef LocalOrdinal local_ordinal_type
typedef GlobalOrdinal global_ordinal_type
typedef Node node_type

Constructor/Destructor Methods

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 = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 63 of file Xpetra_RowGraph.hpp.


Member Typedef Documentation

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 67 of file Xpetra_RowGraph.hpp.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 68 of file Xpetra_RowGraph.hpp.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 69 of file Xpetra_RowGraph.hpp.


Constructor & Destructor Documentation

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

Destructor.

Definition at line 75 of file Xpetra_RowGraph.hpp.


Member Function Documentation

template<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 Teuchos::Comm< int > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const [pure virtual]

Returns the communicator.

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::RCP< Node > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNode ( ) const [pure virtual]

Returns the underlying node.

template<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 Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getRowMap ( ) const [pure virtual]

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

template<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 Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getColMap ( ) const [pure virtual]

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

template<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 Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const [pure virtual]

Returns the Map associated with the domain of this graph.

template<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 Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const [pure virtual]

Returns the Map associated with the domain of this graph.

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getImporter ( ) const [pure virtual]

Returns the importer associated with this graph.

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getExporter ( ) const [pure virtual]

Returns the exporter associated with this graph.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const [pure virtual]

Returns the number of global rows in the graph.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const [pure virtual]

Returns the number of global columns in the graph.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumRows ( ) const [pure virtual]

Returns the number of rows owned on the calling node.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumCols ( ) const [pure virtual]

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

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual GlobalOrdinal Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const [pure virtual]

Returns the index base for global indices for this graph.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const [pure virtual]

Returns the global number of entries in the graph.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumEntries ( ) const [pure virtual]

Returns the local number of entries in the graph.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInGlobalRow ( GlobalOrdinal  globalRow) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInLocalRow ( LocalOrdinal  localRow) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumDiags ( ) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumDiags ( ) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalMaxNumRowEntries ( ) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::hasColMap ( ) const [pure virtual]

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

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isLowerTriangular ( ) const [pure virtual]

Indicates whether the graph is lower triangular.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isUpperTriangular ( ) const [pure virtual]

Indicates whether the graph is upper triangular.

template<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::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. */.

template<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::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. */.

template<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::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isFillComplete ( ) const [pure virtual]

Returns true if fillComplete() has been called.

template<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::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.

template<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::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.


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