Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_RowGraph.hpp>

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

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 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 getLocalNumRows () const =0
 Returns the number of rows owned on the calling node.
 
virtual size_t getLocalNumCols () 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 size_t getGlobalMaxNumRowEntries () const =0
 Returns the maximum number of entries across all rows/columns on all nodes.
 
virtual size_t getLocalMaxNumRowEntries () 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 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.
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

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

Definition at line 63 of file Xpetra_RowGraph.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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

Definition at line 67 of file Xpetra_RowGraph.hpp.

◆ global_ordinal_type

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

Definition at line 68 of file Xpetra_RowGraph.hpp.

◆ node_type

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

Definition at line 69 of file Xpetra_RowGraph.hpp.

Constructor & Destructor Documentation

◆ ~RowGraph()

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

Destructor.

Definition at line 75 of file Xpetra_RowGraph.hpp.

Member Function Documentation

◆ getComm()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual const Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const
pure virtual

Returns the communicator.

◆ getRowMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getColMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getDomainMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getRangeMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getImporter()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getImporter ( ) const
pure virtual

Returns the importer associated with this graph.

◆ getExporter()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getExporter ( ) const
pure virtual

Returns the exporter associated with this graph.

◆ getGlobalNumRows()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const
pure virtual

Returns the number of global rows in the graph.

◆ getGlobalNumCols()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const
pure virtual

Returns the number of global columns in the graph.

◆ getLocalNumRows()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getLocalNumRows ( ) const
pure virtual

Returns the number of rows owned on the calling node.

◆ getLocalNumCols()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getLocalNumCols ( ) const
pure virtual

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

◆ getIndexBase()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const
pure virtual

Returns the index base for global indices for this graph.

◆ getGlobalNumEntries()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const
pure virtual

Returns the global number of entries in the graph.

◆ getNodeNumEntries()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumEntries ( ) const
pure virtual

Returns the local number of entries in the graph.

◆ getNumEntriesInGlobalRow()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getNumEntriesInLocalRow()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getGlobalMaxNumRowEntries()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getLocalMaxNumRowEntries()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::getLocalMaxNumRowEntries ( ) const
pure virtual

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

◆ hasColMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::hasColMap ( ) const
pure virtual

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

◆ isLocallyIndexed()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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. *‍/.

◆ isGloballyIndexed()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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. *‍/.

◆ isFillComplete()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::isFillComplete ( ) const
pure virtual

Returns true if fillComplete() has been called.

◆ getGlobalRowCopy()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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.

◆ getLocalRowCopy()

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
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: