MueLu  Version of the Day
MueLu_Aggregates_kokkos_def.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 // Tobias Wiesner (tawiesn@sandia.gov)
43 //
44 // ***********************************************************************
45 //
46 // @HEADER
47 #ifndef MUELU_AGGREGATES_KOKKOS_DEF_HPP
48 #define MUELU_AGGREGATES_KOKKOS_DEF_HPP
49 
50 #include <Xpetra_Map.hpp>
51 #include <Xpetra_Vector.hpp>
52 #include <Xpetra_VectorFactory.hpp>
53 
54 #include "MueLu_Graph.hpp"
55 #include "MueLu_Utilities_kokkos_decl.hpp" // MueLu_sumAll
57 
58 namespace MueLu {
59 
61  template <class LocalOrdinal, class GlobalOrdinal, class Node>
62  Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::Aggregates_kokkos(const GraphBase & graph) {
63  nAggregates_ = 0;
64 
65  vertex2AggId_ = LOVectorFactory::Build(graph.GetImportMap());
66  vertex2AggId_->putScalar(MUELU_UNAGGREGATED);
67 
68  procWinner_ = LOVectorFactory::Build(graph.GetImportMap());
69  procWinner_->putScalar(MUELU_UNASSIGNED);
70 
71  isRoot_ = Teuchos::ArrayRCP<bool>(graph.GetImportMap()->getNodeNumElements(), false);
72 
73  // slow but safe, force TentativePFactory to build column map for P itself
74  aggregatesIncludeGhosts_ = true;
75  }
76 
78  template <class LocalOrdinal, class GlobalOrdinal, class Node>
79  Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::Aggregates_kokkos(const RCP<const Map> & map) {
80  nAggregates_ = 0;
81 
82  vertex2AggId_ = LOVectorFactory::Build(map);
83  vertex2AggId_->putScalar(MUELU_UNAGGREGATED);
84 
85  procWinner_ = LOVectorFactory::Build(map);
86  procWinner_->putScalar(MUELU_UNASSIGNED);
87 
88  isRoot_ = Teuchos::ArrayRCP<bool>(map->getNodeNumElements(), false);
89 
90  // slow but safe, force TentativePFactory to build column map for P itself
91  aggregatesIncludeGhosts_ = true;
92  }
93 
95  template <class LocalOrdinal, class GlobalOrdinal, class Node>
96  Teuchos::ArrayRCP<LocalOrdinal> Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::ComputeAggregateSizes(bool forceRecompute, bool cacheSizes) const {
97 
98  if (aggregateSizes_ != Teuchos::null && !forceRecompute) {
99 
100  return aggregateSizes_;
101 
102  } else {
103 
104  //invalidate previous sizes.
105  aggregateSizes_ = Teuchos::null;
106 
107  Teuchos::ArrayRCP<LO> aggregateSizes;
108  aggregateSizes = Teuchos::ArrayRCP<LO>(nAggregates_,0);
109  int myPid = vertex2AggId_->getMap()->getComm()->getRank();
110  Teuchos::ArrayRCP<LO> procWinner = procWinner_->getDataNonConst(0);
111  Teuchos::ArrayRCP<LO> vertex2AggId = vertex2AggId_->getDataNonConst(0);
112  LO size = procWinner.size();
113 
114  //for (LO i = 0; i < nAggregates_; ++i) aggregateSizes[i] = 0;
115  for (LO k = 0; k < size; ++k ) {
116  if (procWinner[k] == myPid) aggregateSizes[vertex2AggId[k]]++;
117  }
118 
119  if (cacheSizes)
120  aggregateSizes_ = aggregateSizes;
121 
122  return aggregateSizes;
123  }
124 
125  } //ComputeAggSizesNodes
126 
127  template <class LocalOrdinal, class GlobalOrdinal, class Node>
128  std::string Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::description() const {
129  std::ostringstream out;
130  out << BaseClass::description();
131  out << "{nGlobalAggregates = " << GetNumGlobalAggregates() << "}";
132  return out.str();
133  }
134 
135  template <class LocalOrdinal, class GlobalOrdinal, class Node>
136  void Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::print(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const {
138 
139  if (verbLevel & Statistics0) {
140  out0 << "Global number of aggregates: " << GetNumGlobalAggregates() << std::endl;
141  }
142  }
143 
144  template <class LocalOrdinal, class GlobalOrdinal, class Node>
145  GlobalOrdinal Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::GetNumGlobalAggregates() const {
146  LO nAggregates = GetNumAggregates();
147  GO nGlobalAggregates; MueLu_sumAll(vertex2AggId_->getMap()->getComm(), (GO)nAggregates, nGlobalAggregates);
148  return nGlobalAggregates;
149  }
150 
151  template <class LocalOrdinal, class GlobalOrdinal, class Node>
152  const RCP<const Xpetra::Map<LocalOrdinal,GlobalOrdinal, Node> > Aggregates_kokkos<LocalOrdinal, GlobalOrdinal, Node>::GetMap() const {
153  return vertex2AggId_->getMap();
154  }
155 
156 } //namespace MueLu
157 
158 #endif // MUELU_AGGREGATES_KOKKOS_DEF_HPP
#define MUELU_UNASSIGNED
Namespace for MueLu classes and methods.
Print statistics that do not involve significant additional computation.
#define MueLu_sumAll(rcpComm, in, out)
#define MUELU_UNAGGREGATED
#define MUELU_DESCRIBE
Helper macro for implementing Describable::describe() for BaseClass objects.
virtual std::string description() const
Return a simple one-line description of this object.