MueLu  Version of the Day
MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

MueLu representation of a compressed row storage graph. More...

#include <MueLu_Graph_decl.hpp>

Inheritance diagram for MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >:
MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node > MueLu::BaseClass MueLu::VerboseObject MueLu::Describable

Public Member Functions

size_t GetNodeNumVertices () const
 Return number of vertices owned by the calling node. More...
 
size_t GetNodeNumEdges () const
 Return number of edges owned by the calling node. More...
 
Xpetra::global_size_t GetGlobalNumEdges () const
 Return number of global edges in the graph. More...
 
const RCP< const Teuchos::Comm< int > > GetComm () const
 
const RCP< const Map > GetDomainMap () const
 
const RCP< const Map > GetImportMap () const
 Returns overlapping import map (nodes). More...
 
void SetBoundaryNodeMap (const ArrayRCP< const bool > &localDirichletNodes)
 Set map with local ids of boundary nodes. More...
 
const ArrayRCP< const bool > GetBoundaryNodeMap () const
 Returns map with local ids of boundary nodes. More...
 
size_t getNodeMaxNumRowEntries () const
 Returns the maximum number of entries across all rows/columns on this node. More...
 
ArrayView< const LO > getNeighborVertices (LO i) const
 Return the list of vertices adjacent to the vertex 'v'. More...
 
bool isLocalNeighborVertex (LO i) const
 Return true if vertex with local id 'v' is on current process. More...
 
std::string description () const
 Return a simple one-line description of the Graph. More...
 
void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
 Print the Graph with some verbosity level to an FancyOStream object. More...
 
- Public Member Functions inherited from MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >
virtual ~GraphBase ()
 
virtual Teuchos::ArrayView< const LocalOrdinal > getNeighborVertices (LocalOrdinal v) const =0
 Return the list of vertices adjacent to the vertex 'v'. More...
 
virtual bool isLocalNeighborVertex (LocalOrdinal v) const =0
 Return true if vertex with local id 'v' is on current process. More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
VerbLevel GetVerbLevel () const
 Get the verbosity level. More...
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object. More...
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose. More...
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing. More...
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type. More...
 
Teuchos::FancyOStream & GetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStream & GetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. More...
 
virtual void describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with some verbosity level to an FancyOStream object. More...
 

Private Attributes

RCP< const CrsGraph > graph_
 
ArrayRCP< const bool > localDirichletNodes_
 Vector of Dirichlet boundary node IDs on current process. More...
 
LO minLocalIndex_
 
LO maxLocalIndex_
 

Constructors/Destructors.

 Graph (const RCP< const CrsGraph > &graph, const std::string &objectLabel="")
 
virtual ~Graph ()
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 

Detailed Description

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >

MueLu representation of a compressed row storage graph.

This class holds an underlying Xpetra_CrsGraph. This class can be considered a facade, as MueLu needs only limited functionality for aggregation.

Definition at line 70 of file MueLu_Graph_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::Graph ( const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &  graph,
const std::string &  objectLabel = "" 
)
inline

Definition at line 79 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
virtual MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::~Graph ( )
inlinevirtual

Definition at line 84 of file MueLu_Graph_decl.hpp.

Member Function Documentation

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
size_t MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetNodeNumVertices ( ) const
inlinevirtual

Return number of vertices owned by the calling node.

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 87 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
size_t MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetNodeNumEdges ( ) const
inlinevirtual

Return number of edges owned by the calling node.

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 88 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::global_size_t MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetGlobalNumEdges ( ) const
inlinevirtual

Return number of global edges in the graph.

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 90 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
const RCP<const Teuchos::Comm<int> > MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetComm ( ) const
inlinevirtual
template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
const RCP<const Map> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetDomainMap ( ) const
inlinevirtual
template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
const RCP<const Map> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetImportMap ( ) const
inlinevirtual

Returns overlapping import map (nodes).

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 95 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
void MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::SetBoundaryNodeMap ( const ArrayRCP< const bool > &  localDirichletNodes)
inlinevirtual

Set map with local ids of boundary nodes.

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 98 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
const ArrayRCP<const bool> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetBoundaryNodeMap ( ) const
inlinevirtual

Returns map with local ids of boundary nodes.

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 101 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
size_t MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const
inlinevirtual

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

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 104 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView<const LO> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::getNeighborVertices ( LO  i) const
inline

Return the list of vertices adjacent to the vertex 'v'.

Definition at line 107 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
bool MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::isLocalNeighborVertex ( LO  i) const
inline

Return true if vertex with local id 'v' is on current process.

Definition at line 114 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
std::string MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
inlinevirtual

Return a simple one-line description of the Graph.

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 121 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::print ( Teuchos::FancyOStream &  out,
const VerbLevel  verbLevel = Default 
) const
virtual

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

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

Implements MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 74 of file MueLu_Graph_def.hpp.

Member Data Documentation

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const CrsGraph> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::graph_
private

Definition at line 130 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayRCP<const bool> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::localDirichletNodes_
private

Vector of Dirichlet boundary node IDs on current process.

Definition at line 133 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
LO MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::minLocalIndex_
private

Definition at line 136 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = Xpetra::CrsGraph<>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::CrsGraph<LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
LO MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::maxLocalIndex_
private

Definition at line 136 of file MueLu_Graph_decl.hpp.


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