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

MueLu representation of a graph. More...

#include <MueLu_GraphBase.hpp>

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

Public Member Functions

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
 
- 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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () 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 VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (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 VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () 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)
 

Constructors/Destructors.

virtual ~GraphBase ()
 

Query graph attributes.

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 void SetBoundaryNodeMap (const ArrayRCP< const bool > &boundaryArray)=0
 
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 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...
 

Print graph.

virtual std::string description () const =0
 Return a simple one-line description of the Graph. More...
 
virtual void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const =0
 Print the Graph with some verbosity level to an FancyOStream object. More...
 

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< FancyOStreamgetDefaultOStream ()
 
- 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::GraphBase< LocalOrdinal, GlobalOrdinal, Node >

MueLu representation of a graph.

Pure virtual base class for MueLu representations of graphs.

Definition at line 67 of file MueLu_GraphBase.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::~GraphBase ( )
inlinevirtual

Definition at line 76 of file MueLu_GraphBase.hpp.

Member Function Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual const RCP<const Teuchos::Comm<int> > MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetComm ( ) const
pure virtual
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual const RCP<const Map> MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetDomainMap ( ) const
pure virtual
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual const RCP<const Map> MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetImportMap ( ) const
pure virtual
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual size_t MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetNodeNumVertices ( ) const
pure virtual

Return number of vertices owned by the calling node.

Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual size_t MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetNodeNumEdges ( ) const
pure virtual

Return number of edges owned by the calling node.

Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual void MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::SetBoundaryNodeMap ( const ArrayRCP< const bool > &  boundaryArray)
pure virtual
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual size_t MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const
pure virtual
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual const ArrayRCP<const bool> MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetBoundaryNodeMap ( ) const
pure virtual
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual Xpetra::global_size_t MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::GetGlobalNumEdges ( ) const
pure virtual

Return number of global edges in the graph.

Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual Teuchos::ArrayView<const LocalOrdinal> MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::getNeighborVertices ( LocalOrdinal  v) const
pure virtual

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

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual bool MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::isLocalNeighborVertex ( LocalOrdinal  v) const
pure virtual

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

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual std::string MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
pure virtual

Return a simple one-line description of the Graph.

Reimplemented from MueLu::Describable.

Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual void MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::print ( Teuchos::FancyOStream out,
const VerbLevel  verbLevel = Default 
) const
pure virtual

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

Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.


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