MueLu  Version of the Day
MueLu_LWGraph_decl.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_LWGRAPH_DECL_HPP
47 #define MUELU_LWGRAPH_DECL_HPP
48 
49 #include <Xpetra_ConfigDefs.hpp> // global_size_t
50 #include <Xpetra_CrsGraph.hpp> // inline functions requires class declaration
51 #include <Xpetra_CrsGraphFactory.hpp>
52 #include <Xpetra_Map_fwd.hpp>
53 
54 #include "MueLu_ConfigDefs.hpp"
55 
56 #include "MueLu_LWGraph_fwd.hpp"
57 #include "MueLu_GraphBase.hpp"
58 #include "MueLu_Exceptions.hpp"
59 
60 namespace MueLu {
61 
70  template<class LocalOrdinal = DefaultLocalOrdinal,
72  class Node = DefaultNode>
73  class LWGraph : public MueLu::GraphBase<LocalOrdinal,GlobalOrdinal,Node> {
74 #undef MUELU_LWGRAPH_SHORT
76 
77  public:
78 
80 
81 
83  //
84  // @param[in] rowPtrs: Array containing row offsets (CSR format)
85  // @param[in] colPtrs: Array containing local column indices (CSR format)
86  // @param[in] domainMap: non-overlapping (domain) map for graph. Usually provided by AmalgamationFactory stored in UnAmalgamationInfo container
87  // @param[in] importMap: overlapping map for graph. Usually provided by AmalgamationFactory stored in UnAmalgamationInfo container
88  // @param[in] objectLabel: label string
89  LWGraph(const ArrayRCP<const LO>& rowPtrs, const ArrayRCP<const LO>& colPtrs,
90  const RCP<const Map>& domainMap, const RCP<const Map>& importMap, const std::string& objectLabel = "")
91  : rows_(rowPtrs), columns_(colPtrs), domainMap_(domainMap), importMap_(importMap), domainMapRef_(*domainMap), objectLabel_(objectLabel)
92  {
93  minLocalIndex_ = domainMapRef_.getMinLocalIndex();
94  maxLocalIndex_ = domainMapRef_.getMaxLocalIndex();
95 
97 
98  LO nRows = as<LO>(rowPtrs.size()-1);
99  for (LO i = 0; i < nRows; i++)
100  maxNumRowEntries_ = std::max(maxNumRowEntries_, as<size_t>(rowPtrs[i+1] - rowPtrs[i]));
101  }
102 
103  virtual ~LWGraph() {}
105 
106  size_t GetNodeNumVertices() const { return rows_.size()-1; }
107  size_t GetNodeNumEdges() const { return rows_[rows_.size()-1]; }
108 
109  // TODO: do we really need this function
110  // It is being called from CoupledAggregation, but do we need it there?
111  Xpetra::global_size_t GetGlobalNumEdges() const {
112  Xpetra::global_size_t in = GetNodeNumEdges(), out;
113  Teuchos::reduceAll(*domainMap_->getComm(), Teuchos::REDUCE_SUM, in, Teuchos::outArg(out));
114  return out;
115  }
116 
117  const RCP<const Teuchos::Comm<int> > GetComm() const { return domainMap_->getComm(); }
118  const RCP<const Map> GetDomainMap() const { return domainMap_; }
120  const RCP<const Map> GetImportMap() const { return importMap_; }
121 
122  void SetBoundaryNodeMap(RCP<const Map> const &/* map */) { throw Exceptions::NotImplemented("LWGraph: Boundary node map not implemented."); }
123 
125  Teuchos::ArrayView<const LO> getNeighborVertices(LO i) const { return columns_.view(rows_[i], rows_[i+1]-rows_[i]); }
126 
128  bool isLocalNeighborVertex(LO i) const { return i >= minLocalIndex_ && i <= maxLocalIndex_; }
129 
131  void SetBoundaryNodeMap(const ArrayRCP<const bool>& bndry) { dirichletBoundaries_ = bndry; }
132 
134  size_t getNodeMaxNumRowEntries () const { return maxNumRowEntries_; }
135 
137  const ArrayRCP<const bool> GetBoundaryNodeMap() const { return dirichletBoundaries_; }
138 
139 
141  std::string description() const { return "MueLu.description()"; } //FIXME use object's label
142 
144  const ArrayRCP<const LO> getRowPtrs() const {
145  return rows_;
146  }
147 
149  const ArrayRCP<const LO> getEntries() const {
150  return columns_;
151  }
152 
154  //using MueLu::Describable::describe; // overloading, not hiding
155  //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;;
156  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
157 
158 
159  RCP<CrsGraph> GetCrsGraph() const {
160  ArrayRCP<size_t> rowPtrs;
161  rowPtrs.resize(rows_.size());
162  for (size_t i=0; i<Teuchos::as<size_t>(rows_.size()); i++)
163  rowPtrs[i] = rows_[i];
164  auto graph = Xpetra::CrsGraphFactory<LocalOrdinal,GlobalOrdinal,Node>::Build(GetDomainMap(), GetImportMap(), rowPtrs, Teuchos::arcp_const_cast<LO>(getEntries()));
165  graph->fillComplete();
166  return graph;
167  }
168 
169  private:
170 
172  const ArrayRCP<const LO> rows_;
174  const ArrayRCP<const LO> columns_;
176  const RCP<const Map> domainMap_, importMap_;
177  const Map& domainMapRef_;
179  const std::string & objectLabel_;
181  ArrayRCP<const bool> dirichletBoundaries_;
182 
183  // local index boundaries (cached from domain map)
186  };
187 
188 } // namespace MueLu
189 
190 #define MUELU_LWGRAPH_SHORT
191 #endif // MUELU_LWGRAPH_DECL_HPP
Teuchos::ArrayView< const LO > getNeighborVertices(LO i) const
Return the list of vertices adjacent to the vertex &#39;v&#39;.
MueLu::DefaultLocalOrdinal LocalOrdinal
bool isLocalNeighborVertex(LO i) const
Return true if vertex with local id &#39;v&#39; is on current process.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
const Map & domainMapRef_
size_t GetNodeNumVertices() const
Return number of vertices owned by the calling node.
const RCP< const Teuchos::Comm< int > > GetComm() const
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the Graph with some verbosity level to an FancyOStream object.
Namespace for MueLu classes and methods.
const ArrayRCP< const LO > getEntries() const
Return the list entries in the local graph.
const RCP< const Map > domainMap_
Graph maps.
MueLu::DefaultNode Node
LWGraph(const ArrayRCP< const LO > &rowPtrs, const ArrayRCP< const LO > &colPtrs, const RCP< const Map > &domainMap, const RCP< const Map > &importMap, const std::string &objectLabel="")
LWGraph constructor.
const RCP< const Map > GetDomainMap() const
size_t GetNodeNumEdges() const
Return number of edges owned by the calling node.
size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
const ArrayRCP< const LO > rows_
Indices into columns_ array. Part of local graph information.
MueLu::DefaultGlobalOrdinal GlobalOrdinal
RCP< CrsGraph > GetCrsGraph() const
Exception throws when you call an unimplemented method of MueLu.
Xpetra::global_size_t GetGlobalNumEdges() const
Return number of global edges in the graph.
std::string description() const
Return a simple one-line description of the Graph.
const ArrayRCP< const LO > columns_
Columns corresponding to connections. Part of local graph information.
ArrayRCP< const bool > dirichletBoundaries_
Boolean array marking Dirichlet rows.
const std::string & objectLabel_
Name of this graph.
MueLu representation of a graph.
const RCP< const Map > GetImportMap() const
Returns overlapping import map (nodes).
void SetBoundaryNodeMap(const ArrayRCP< const bool > &bndry)
Set boolean array indicating which rows correspond to Dirichlet boundaries.
void SetBoundaryNodeMap(RCP< const Map > const &)
Lightweight MueLu representation of a compressed row storage graph.
const ArrayRCP< const bool > GetBoundaryNodeMap() const
Returns map with global ids of boundary nodes.
const ArrayRCP< const LO > getRowPtrs() const
Return the row pointers of the local graph.
const RCP< const Map > importMap_