Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_CrsGraph.hpp>

Inheritance diagram for Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::DistObject< GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node > Xpetra::TpetraCrsGraph< LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Constructor/Destructor Methods

virtual ~CrsGraph ()
 Destructor. More...
 

Insertion/Removal Methods

virtual void insertGlobalIndices (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices)=0
 Insert global indices into the graph. More...
 
virtual void insertLocalIndices (const LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices)=0
 Insert local indices into the graph. More...
 
virtual void removeLocalIndices (LocalOrdinal localRow)=0
 Remove all graph indices from the specified local row. More...
 

Transformational Methods

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

Methods implementing RowGraph.

virtual RCP< const Comm< int > > getComm () const =0
 Returns the communicator. More...
 
virtual RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getRowMap () const =0
 Returns the Map that describes the row distribution in this graph. More...
 
virtual RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getColMap () const =0
 Returns the Map that describes the column distribution in this graph. More...
 
virtual RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getDomainMap () const =0
 Returns the Map associated with the domain of this graph. More...
 
virtual RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getRangeMap () const =0
 Returns the Map associated with the domain of this graph. More...
 
virtual RCP< const Import
< LocalOrdinal, GlobalOrdinal,
Node > > 
getImporter () const =0
 Returns the importer associated with this graph. More...
 
virtual RCP< const Export
< LocalOrdinal, GlobalOrdinal,
Node > > 
getExporter () const =0
 Returns the exporter associated with this graph. More...
 
virtual global_size_t getGlobalNumRows () const =0
 Returns the number of global rows in the graph. More...
 
virtual global_size_t getGlobalNumCols () const =0
 Returns the number of global columns in the graph. More...
 
virtual size_t getNodeNumRows () const =0
 Returns the number of graph rows owned on the calling node. More...
 
virtual size_t getNodeNumCols () const =0
 Returns the number of columns connected to the locally owned rows of this graph. More...
 
virtual GlobalOrdinal getIndexBase () const =0
 Returns the index base for global indices for this graph. More...
 
virtual global_size_t getGlobalNumEntries () const =0
 Returns the global number of entries in the graph. More...
 
virtual size_t getNodeNumEntries () const =0
 Returns the local number of entries in the graph. More...
 
virtual size_t getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const =0
 Returns the current number of entries on this node in the specified global row. More...
 
virtual size_t getNumEntriesInLocalRow (LocalOrdinal localRow) const =0
 Returns the current number of entries on this node in the specified local row. More...
 
virtual size_t getNumAllocatedEntriesInGlobalRow (GlobalOrdinal globalRow) const =0
 Returns the current number of allocated entries for this node in the specified global row . More...
 
virtual size_t getNumAllocatedEntriesInLocalRow (LocalOrdinal localRow) const =0
 Returns the current number of allocated entries on this node in the specified local row. More...
 
virtual size_t getGlobalMaxNumRowEntries () const =0
 Maximum number of entries in all rows over all processes. More...
 
virtual size_t getNodeMaxNumRowEntries () const =0
 Maximum number of entries in all rows owned by the calling process. More...
 
virtual bool hasColMap () const =0
 Whether the graph has a column Map. More...
 
virtual bool isLocallyIndexed () const =0
 Whether column indices are stored using local indices on the calling process. More...
 
virtual bool isGloballyIndexed () const =0
 Whether column indices are stored using global indices on the calling process. More...
 
virtual bool isFillComplete () const =0
 Whether fillComplete() has been called and the graph is in compute mode. More...
 
virtual bool isStorageOptimized () const =0
 Returns true if storage has been optimized. More...
 
virtual void getGlobalRowView (GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &Indices) const =0
 Return a const, nonpersisting view of global indices in the given row. More...
 
virtual void getLocalRowView (LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices) const =0
 Return a const, nonpersisting view of local indices in the given row. More...
 
virtual void computeGlobalConstants ()=0
 Force the computation of global constants if we don't have them. More...
 

Overridden from Teuchos::Describable

virtual std::string description () const =0
 Return a simple one-line description of this object. More...
 
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. More...
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 84 of file Xpetra_CrsGraph.hpp.

Member Typedef Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef LocalOrdinal Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 88 of file Xpetra_CrsGraph.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef GlobalOrdinal Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 89 of file Xpetra_CrsGraph.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Node Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 90 of file Xpetra_CrsGraph.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::~CrsGraph ( )
inlinevirtual

Destructor.

Definition at line 96 of file Xpetra_CrsGraph.hpp.

Member Function Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::insertGlobalIndices ( GlobalOrdinal  globalRow,
const ArrayView< const GlobalOrdinal > &  indices 
)
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::insertLocalIndices ( const LocalOrdinal  localRow,
const ArrayView< const LocalOrdinal > &  indices 
)
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::removeLocalIndices ( LocalOrdinal  localRow)
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::fillComplete ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap,
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap,
const RCP< ParameterList > &  params = null 
)
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::fillComplete ( const RCP< ParameterList > &  params = null)
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Comm< int > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getRowMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getColMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getImporter ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getExporter ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumRows ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumCols ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumEntries ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInGlobalRow ( GlobalOrdinal  globalRow) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInLocalRow ( LocalOrdinal  localRow) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumAllocatedEntriesInGlobalRow ( GlobalOrdinal  globalRow) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNumAllocatedEntriesInLocalRow ( LocalOrdinal  localRow) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalMaxNumRowEntries ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::hasColMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::isLocallyIndexed ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::isGloballyIndexed ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::isFillComplete ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::isStorageOptimized ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalRowView ( GlobalOrdinal  GlobalRow,
ArrayView< const GlobalOrdinal > &  Indices 
) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::getLocalRowView ( LocalOrdinal  LocalRow,
ArrayView< const LocalOrdinal > &  indices 
) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::computeGlobalConstants ( )
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual std::string Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const
pure virtual

The documentation for this class was generated from the following file: