MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_GraphBase.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// MueLu: A package for multigrid based preconditioning
6// Copyright 2012 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact
39// Jonathan Hu (jhu@sandia.gov)
40// Andrey Prokopenko (aprokop@sandia.gov)
41// Ray Tuminaro (rstumin@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46#ifndef MUELU_GRAPHBASE_HPP
47#define MUELU_GRAPHBASE_HPP
48
49#include <Xpetra_ConfigDefs.hpp> // global_size_t
50#include <Xpetra_Map_fwd.hpp>
51
52#include "MueLu_ConfigDefs.hpp"
53
54#include "MueLu_BaseClass.hpp"
55
56namespace MueLu {
57
64 template<class LocalOrdinal = DefaultLocalOrdinal,
66 class Node = DefaultNode>
68 : public BaseClass {
69#undef MUELU_GRAPHBASE_SHORT
71
72 public:
73 // For Zoltan2 compatibility
76 using node_t = Node;
77
79
80 virtual ~GraphBase() {};
82
83 virtual const RCP<const Teuchos::Comm<int> > GetComm() const = 0;
84 virtual const RCP<const Map> GetDomainMap() const = 0;
85 virtual const RCP<const Map> GetImportMap() const = 0;
86
88
89
91 virtual size_t GetNodeNumVertices() const = 0;
92
94 virtual size_t GetNodeNumEdges() const = 0;
95
96 virtual void SetBoundaryNodeMap(const ArrayRCP<const bool > & boundaryArray) = 0;
97
98 virtual size_t getLocalMaxNumRowEntries() const = 0;
99
100 virtual const ArrayRCP<const bool> GetBoundaryNodeMap() const = 0;
101
102 //FIXME is this necessary?
104 virtual Xpetra::global_size_t GetGlobalNumEdges() const = 0;
105
107 virtual Teuchos::ArrayView<const LocalOrdinal> getNeighborVertices(LocalOrdinal v) const = 0;
108
110 virtual bool isLocalNeighborVertex(LocalOrdinal v) const = 0;
112
114
115
116 virtual std::string description() const = 0;
117
119 //using MueLu::Describable::describe; // overloading, not hiding
120 //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;;
121 virtual void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const = 0;
123
124 };
125
126} // namespace MueLu
127
128#define MUELU_GRAPHBASE_SHORT
129#endif // MUELU_GRAPHBASE_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Base class for MueLu classes.
MueLu representation of a graph.
virtual const ArrayRCP< const bool > GetBoundaryNodeMap() const =0
virtual const RCP< const Teuchos::Comm< int > > GetComm() const =0
virtual const RCP< const Map > GetDomainMap() const =0
virtual size_t GetNodeNumEdges() const =0
Return number of edges owned by the calling node.
virtual bool isLocalNeighborVertex(LocalOrdinal v) const =0
Return true if vertex with local id 'v' is on current process.
virtual void SetBoundaryNodeMap(const ArrayRCP< const bool > &boundaryArray)=0
virtual void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const =0
Print the Graph with some verbosity level to an FancyOStream object.
virtual Xpetra::global_size_t GetGlobalNumEdges() const =0
Return number of global edges in the graph.
GlobalOrdinal gno_t
virtual std::string description() const =0
Return a simple one-line description of the Graph.
virtual const RCP< const Map > GetImportMap() const =0
virtual Teuchos::ArrayView< const LocalOrdinal > getNeighborVertices(LocalOrdinal v) const =0
Return the list of vertices adjacent to the vertex 'v'.
virtual size_t getLocalMaxNumRowEntries() const =0
virtual size_t GetNodeNumVertices() const =0
Return number of vertices owned by the calling node.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode