MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
56 namespace MueLu {
57 
64  template <class LocalOrdinal = int,
65  class GlobalOrdinal = LocalOrdinal,
67  class GraphBase
68  : public BaseClass {
69 #undef MUELU_GRAPHBASE_SHORT
71 
72  public:
73 
75 
76  virtual ~GraphBase() {};
78 
79  virtual const RCP<const Teuchos::Comm<int> > GetComm() const = 0;
80  virtual const RCP<const Map> GetDomainMap() const = 0;
81  virtual const RCP<const Map> GetImportMap() const = 0;
82 
84 
85 
87  virtual size_t GetNodeNumVertices() const = 0;
88 
90  virtual size_t GetNodeNumEdges() const = 0;
91 
92  virtual void SetBoundaryNodeMap(const ArrayRCP<const bool > & boundaryArray) = 0;
93 
94  virtual size_t getNodeMaxNumRowEntries() const = 0;
95 
96  virtual const ArrayRCP<const bool> GetBoundaryNodeMap() const = 0;
97 
98  //FIXME is this necessary?
100  virtual Xpetra::global_size_t GetGlobalNumEdges() const = 0;
101 
103  virtual Teuchos::ArrayView<const LocalOrdinal> getNeighborVertices(LocalOrdinal v) const = 0;
104 
106  virtual bool isLocalNeighborVertex(LocalOrdinal v) const = 0;
108 
110 
111  virtual std::string description() const = 0;
113 
115  //using MueLu::Describable::describe; // overloading, not hiding
116  //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;;
117  virtual void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const = 0;
119 
120  };
121 
122 } // namespace MueLu
123 
124 #define MUELU_GRAPHBASE_SHORT
125 #endif // MUELU_GRAPHBASE_HPP
virtual size_t getNodeMaxNumRowEntries() const =0
virtual size_t GetNodeNumVertices() const =0
Return number of vertices owned by the calling node.
virtual size_t GetNodeNumEdges() const =0
Return number of edges owned by the calling node.
virtual const ArrayRCP< const bool > GetBoundaryNodeMap() const =0
virtual const RCP< const Map > GetDomainMap() const =0
virtual Xpetra::global_size_t GetGlobalNumEdges() const =0
Return number of global edges in the graph.
virtual void SetBoundaryNodeMap(const ArrayRCP< const bool > &boundaryArray)=0
virtual bool isLocalNeighborVertex(LocalOrdinal v) const =0
Return true if vertex with local id &#39;v&#39; is on current process.
virtual const RCP< const Teuchos::Comm< int > > GetComm() const =0
size_t global_size_t
MueLu representation of a graph.
Base class for MueLu classes.
virtual std::string description() const =0
Return a simple one-line description of the Graph.
virtual void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const =0
Print the Graph with some verbosity level to an FancyOStream object.
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 &#39;v&#39;.