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

#include <MueLu_Graph_decl.hpp>

Inheritance diagram for MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >:

Constructors/Destructors.
RCP< const CrsGraph >	graph_

ArrayRCP< const bool >	localDirichletNodes_
	Vector of Dirichlet boundary node IDs on current process. More...

LO	minLocalIndex_

LO	maxLocalIndex_

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

virtual	~Graph ()

size_t	GetNodeNumVertices () const

size_t	GetNodeNumEdges () const

Xpetra::global_size_t	GetGlobalNumEdges () const

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

Additional Inherited Members
Public Member Functions inherited from MueLu::GraphBase< Xpetra::CrsGraph<>::local_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type >::global_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type >::global_ordinal_type >::node_type >
virtual	~GraphBase ()

virtual const RCP< const Teuchos::Comm< int > >	GetComm () const=0

virtual const RCP< const Map >	GetDomainMap () const=0

virtual const RCP< const Map >	GetImportMap () const=0

virtual size_t	GetNodeNumVertices () const=0
	Return number of vertices owned by the calling node. More...

virtual size_t	GetNodeNumEdges () const=0
	Return number of edges owned by the calling node. More...

virtual size_t	getNodeMaxNumRowEntries () const=0

virtual const ArrayRCP< const bool >	GetBoundaryNodeMap () const=0

virtual Xpetra::global_size_t	GetGlobalNumEdges () const=0
	Return number of global edges in the graph. More...

virtual Teuchos::ArrayView< const Xpetra::CrsGraph<>::local_ordinal_type >	getNeighborVertices (Xpetra::CrsGraph<>::local_ordinal_type v) const=0
	Return the list of vertices adjacent to the vertex 'v'. More...

virtual bool	isLocalNeighborVertex (Xpetra::CrsGraph<>::local_ordinal_type v) const=0
	Return true if vertex with local id 'v' is on current process. More...

virtual std::string	description () const=0
	Return a simple one-line description of the Graph. More...

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor. More...

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

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

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor. 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...

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

static void	SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)

static Teuchos::RCP< Teuchos::FancyOStream >	GetDefaultOStream ()

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

◆ Graph()

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.

◆ ~Graph()

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

◆ GetNodeNumVertices()

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

inline

Definition at line 87 of file MueLu_Graph_decl.hpp.

◆ GetNodeNumEdges()

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

inline

Definition at line 88 of file MueLu_Graph_decl.hpp.

◆ GetGlobalNumEdges()

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

inline

Definition at line 90 of file MueLu_Graph_decl.hpp.

◆ GetComm()

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

inline

Definition at line 92 of file MueLu_Graph_decl.hpp.

◆ GetDomainMap()

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

inline

Definition at line 93 of file MueLu_Graph_decl.hpp.

◆ GetImportMap()

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

inline

Returns overlapping import map (nodes).

Definition at line 95 of file MueLu_Graph_decl.hpp.

◆ SetBoundaryNodeMap()

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< Xpetra::CrsGraph<>::local_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type >::global_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 98 of file MueLu_Graph_decl.hpp.

◆ GetBoundaryNodeMap()

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

inline

Returns map with local ids of boundary nodes.

Definition at line 101 of file MueLu_Graph_decl.hpp.

◆ getNodeMaxNumRowEntries()

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

inline

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

Definition at line 104 of file MueLu_Graph_decl.hpp.

◆ getNeighborVertices()

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.

◆ isLocalNeighborVertex()

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.

◆ 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>

std::string MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

inlinevirtual

Return a simple one-line description of the Graph.

Reimplemented from MueLu::Describable.

Definition at line 121 of file MueLu_Graph_decl.hpp.

◆ print()

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< Xpetra::CrsGraph<>::local_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type >::global_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type, typename Xpetra::CrsGraph< Xpetra::CrsGraph<>::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 74 of file MueLu_Graph_def.hpp.

Member Data Documentation

◆ graph_

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.

◆ localDirichletNodes_

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.

◆ minLocalIndex_

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.

◆ maxLocalIndex_

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:

Constructors/Destructors.

Additional Inherited Members

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 >

Constructor & Destructor Documentation

◆ Graph()

◆ ~Graph()

Member Function Documentation

◆ GetNodeNumVertices()

◆ GetNodeNumEdges()

◆ GetGlobalNumEdges()

◆ GetComm()

◆ GetDomainMap()

◆ GetImportMap()

◆ SetBoundaryNodeMap()

◆ GetBoundaryNodeMap()

◆ getNodeMaxNumRowEntries()

◆ getNeighborVertices()

◆ isLocalNeighborVertex()

◆ description()

◆ print()

Member Data Documentation

◆ graph_

◆ localDirichletNodes_

◆ minLocalIndex_

◆ maxLocalIndex_

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 >