MueLu  Version of the Day
MueLu_Aggregates_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 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_AGGREGATES_DEF_HPP
47 #define MUELU_AGGREGATES_DEF_HPP
48 
49 #include <Xpetra_Map.hpp>
50 #include <Xpetra_Vector.hpp>
51 #include <Xpetra_MultiVector.hpp>
52 #include <Xpetra_BlockedMultiVector.hpp>
53 #include <Xpetra_BlockedVector.hpp>
54 #include <Xpetra_VectorFactory.hpp>
55 #include <Xpetra_MultiVectorFactory.hpp>
56 
58 #include "MueLu_Graph.hpp"
59 #include "MueLu_Utilities_decl.hpp" // MueLu_sumAll
60 
61 namespace MueLu {
62 
64  template <class LocalOrdinal, class GlobalOrdinal, class Node>
66  nAggregates_ = 0;
67 
68  vertex2AggId_ = LOMultiVectorFactory::Build(graph.GetImportMap(), 1);
69  vertex2AggId_->putScalar(MUELU_UNAGGREGATED);
70 
71  procWinner_ = LOVectorFactory::Build(graph.GetImportMap());
72  procWinner_->putScalar(MUELU_UNASSIGNED);
73 
74  isRoot_ = Teuchos::ArrayRCP<bool>(graph.GetImportMap()->getNodeNumElements(), false);
75 
76  // slow but safe, force TentativePFactory to build column map for P itself
77  aggregatesIncludeGhosts_ = true;
78  }
79 
81  template <class LocalOrdinal, class GlobalOrdinal, class Node>
83  nAggregates_ = 0;
84 
85  vertex2AggId_ = LOMultiVectorFactory::Build(map, 1);
86  vertex2AggId_->putScalar(MUELU_UNAGGREGATED);
87 
88  procWinner_ = LOVectorFactory::Build(map);
89  procWinner_->putScalar(MUELU_UNASSIGNED);
90 
91  isRoot_ = Teuchos::ArrayRCP<bool>(map->getNodeNumElements(), false);
92 
93  // slow but safe, force TentativePFactory to build column map for P itself
94  aggregatesIncludeGhosts_ = true;
95  }
96 
98  template <class LocalOrdinal, class GlobalOrdinal, class Node>
99  Teuchos::ArrayRCP<LocalOrdinal> Aggregates<LocalOrdinal, GlobalOrdinal, Node>::ComputeAggregateSizes(bool forceRecompute) const {
100 
101  if (aggregateSizes_ != Teuchos::null && !forceRecompute) {
102 
103  return aggregateSizes_;
104 
105  } else {
106 
107  //invalidate previous sizes.
108  aggregateSizes_ = Teuchos::null;
109 
110  Teuchos::ArrayRCP<LO> aggregateSizes;
111  aggregateSizes = Teuchos::ArrayRCP<LO>(nAggregates_,0);
112  int myPid = vertex2AggId_->getMap()->getComm()->getRank();
113  Teuchos::ArrayRCP<LO> procWinner = procWinner_->getDataNonConst(0);
114  Teuchos::ArrayRCP<LO> vertex2AggId = vertex2AggId_->getDataNonConst(0);
115  LO size = procWinner.size();
116 
117  //for (LO i = 0; i < nAggregates_; ++i) aggregateSizes[i] = 0;
118  for (LO k = 0; k < size; ++k ) {
119  if (procWinner[k] == myPid) aggregateSizes[vertex2AggId[k]]++;
120  }
121 
122  aggregateSizes_ = aggregateSizes;
123 
124  return aggregateSizes;
125  }
126 
127  } //ComputeAggSizesNodes
128 
129  template <class LocalOrdinal, class GlobalOrdinal, class Node>
131  std::ostringstream out;
132  out << BaseClass::description();
133  out << "{nGlobalAggregates = " << GetNumGlobalAggregates() << "}";
134  return out.str();
135  }
136 
137  template <class LocalOrdinal, class GlobalOrdinal, class Node>
138  void Aggregates<LocalOrdinal, GlobalOrdinal, Node>::print(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const {
140 
141  if (verbLevel & Statistics1)
142  out0 << "Global number of aggregates: " << GetNumGlobalAggregates() << std::endl;
143 
144  if(verbLevel == Teuchos::VERB_EXTREME) {
145  for(size_t j=0; j <vertex2AggId_->getNumVectors(); j++) {
146  auto data = vertex2AggId_->getData(j);
147  for(size_t i=0; i<vertex2AggId_->getLocalLength(); i++) {
148  out<<i<<" : "<< data[i] <<std::endl;
149  }
150  out<<std::endl;
151  }
152  }
153 
154  }
155 
156  template <class LocalOrdinal, class GlobalOrdinal, class Node>
158  LO nAggregates = GetNumAggregates();
159  GO nGlobalAggregates; MueLu_sumAll(vertex2AggId_->getMap()->getComm(), (GO)nAggregates, nGlobalAggregates);
160  return nGlobalAggregates;
161  }
162 
163  template <class LocalOrdinal, class GlobalOrdinal, class Node>
164  const RCP<const Xpetra::Map<LocalOrdinal,GlobalOrdinal, Node> > Aggregates<LocalOrdinal, GlobalOrdinal, Node>::GetMap() const {
165  return vertex2AggId_->getMap();
166  }
167 
168  template <class LocalOrdinal, class GlobalOrdinal, class Node>
169  void Aggregates<LocalOrdinal, GlobalOrdinal, Node>::ComputeNodesInAggregate(Array<LO> & aggPtr, Array<LO> & aggNodes, Array<LO> & unaggregated) const {
170  LO numAggs = GetNumAggregates();
171  LO numNodes = vertex2AggId_->getLocalLength();
172  Teuchos::ArrayRCP<const LO> vertex2AggId = vertex2AggId_->getData(0);
173  Teuchos::ArrayRCP<LO> aggSizes = ComputeAggregateSizes(true);
174  LO INVALID = Teuchos::OrdinalTraits<LO>::invalid();
175 
176  aggPtr.resize(numAggs+1);
177  Array<LO> aggCurr(numAggs+1);
178  aggNodes.resize(numNodes);
179  unaggregated.resize(numNodes);
180 
181  LO currNumUnaggregated=0;
182 
183  // Construct the "rowptr" and the counter
184  aggPtr[0] = 0;
185  for(LO i=0; i<numAggs; i++) {
186  aggPtr[i+1] = aggSizes[i] + aggPtr[i];
187  aggCurr[i] = aggPtr[i];
188  }
189 
190  // Stick the nodes in each aggregate's spot
191  for(LO i=0; i<numNodes; i++) {
192  LO aggregate = vertex2AggId[i];
193  if(aggregate !=INVALID) {
194  aggNodes[aggCurr[aggregate]] = i;
195  aggCurr[aggregate]++;
196  }
197  else {
198  unaggregated[currNumUnaggregated] = i;
199  currNumUnaggregated++;
200  }
201  }
202  unaggregated.resize(currNumUnaggregated);
203 
204  }
205 
206 
207 } //namespace MueLu
208 
209 #endif // MUELU_AGGREGATES_DEF_HPP
#define MUELU_UNASSIGNED
std::string description() const
Return a simple one-line description of this object.
#define MueLu_sumAll(rcpComm, in, out)
void print(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=verbLevel_default) const
Print the object with some verbosity level to an FancyOStream object.
Print more statistics.
Namespace for MueLu classes and methods.
Aggregates(const GraphBase &graph)
Standard constructor for Aggregates structure.
GO GetNumGlobalAggregates() const
Get global number of aggregates.
MueLu::DefaultGlobalOrdinal GlobalOrdinal
#define MUELU_UNAGGREGATED
#define MUELU_DESCRIBE
Helper macro for implementing Describable::describe() for BaseClass objects.
const RCP< const Map > GetMap() const
returns (overlapping) map of aggregate/node distribution
MueLu representation of a graph.
void ComputeNodesInAggregate(Array< LO > &aggPtr, Array< LO > &aggNodes, Array< LO > &unaggregated) const
Generates a compressed list of nodes in each aggregate, where the entries in aggNodes[aggPtr[i]] up t...
virtual const RCP< const Map > GetImportMap() const =0
virtual std::string description() const
Return a simple one-line description of this object.
Teuchos::ArrayRCP< LO > ComputeAggregateSizes(bool forceRecompute=false) const
Compute sizes of aggregates.