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

#include <MueLu_Graph_decl.hpp>

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

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 Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

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

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

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 &="")

virtual	~Graph ()

Additional Inherited Members
Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

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

static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

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

Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

Detailed Description

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::Graph	(	const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &	graph,
		const std::string &	= `""`
	)

inline

Definition at line 79 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

virtual MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::~Graph ( )

inlinevirtual

Definition at line 84 of file MueLu_Graph_decl.hpp.

Member Function Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

const RCP<const Teuchos::Comm<int> > MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetComm ( ) const

inlinevirtual

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

Definition at line 92 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

const RCP<const Map> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::GetDomainMap ( ) const

inlinevirtual

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

Definition at line 93 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

RCP<const CrsGraph> MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::graph_

private

Definition at line 130 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

LO MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >::minLocalIndex_

private

Definition at line 136 of file MueLu_Graph_decl.hpp.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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:

Public Member Functions

Private Attributes

Constructors/Destructors.

Additional Inherited Members

Detailed Description

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode> class MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >