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 >:
Public Types | |
| using | lno_t = LocalOrdinal |
| using | gno_t = GlobalOrdinal |
| using | node_t = Node |
Constructors/Destructors. | |
| 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 |
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 | |
 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 | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
| static void | SetMueLuOFileStream (const std::string &filename) |
| static Teuchos::RCP< Teuchos::FancyOStream > | GetMueLuOStream () |
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.
Member Typedef Documentation
◆ lno_t
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
| using MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::lno_t = LocalOrdinal |
Definition at line 74 of file MueLu_GraphBase.hpp.
◆ gno_t
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
| using MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::gno_t = GlobalOrdinal |
Definition at line 75 of file MueLu_GraphBase.hpp.
◆ node_t
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
| using MueLu::GraphBase< LocalOrdinal, GlobalOrdinal, Node >::node_t = Node |
Definition at line 76 of file MueLu_GraphBase.hpp.
Constructor & Destructor Documentation
◆ ~GraphBase()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inlinevirtual |
Definition at line 80 of file MueLu_GraphBase.hpp.
Member Function Documentation
◆ GetComm()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
◆ GetDomainMap()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
◆ GetImportMap()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
◆ GetNodeNumVertices()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
Return number of vertices owned by the calling node.
Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.
◆ GetNodeNumEdges()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
Return number of edges owned by the calling node.
Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.
◆ SetBoundaryNodeMap()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
◆ getNodeMaxNumRowEntries()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
◆ GetBoundaryNodeMap()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
◆ GetGlobalNumEdges()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
Return number of global edges in the graph.
Implemented in MueLu::LWGraph< LocalOrdinal, GlobalOrdinal, Node >, and MueLu::Graph< LocalOrdinal, GlobalOrdinal, Node >.
◆ getNeighborVertices()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
Return the list of vertices adjacent to the vertex 'v'.
◆ isLocalNeighborVertex()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
pure virtual |
Return true if vertex with local id 'v' is on current process.
◆ description()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
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 >.
◆ print()
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
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:
