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_VectorFactory.hpp>
52 
54 #include "MueLu_Graph.hpp"
55 #include "MueLu_Utilities_decl.hpp" // MueLu_sumAll
56 
57 namespace MueLu {
58 
60  template <class LocalOrdinal, class GlobalOrdinal, class Node>
62  nAggregates_ = 0;
63 
64  vertex2AggId_ = LOVectorFactory::Build(graph.GetImportMap());
65  vertex2AggId_->putScalar(MUELU_UNAGGREGATED);
66 
67  procWinner_ = LOVectorFactory::Build(graph.GetImportMap());
68  procWinner_->putScalar(MUELU_UNASSIGNED);
69 
70  isRoot_ = Teuchos::ArrayRCP<bool>(graph.GetImportMap()->getNodeNumElements(), false);
71 
72  // slow but safe, force TentativePFactory to build column map for P itself
73  aggregatesIncludeGhosts_ = true;
74  }
75 
77  template <class LocalOrdinal, class GlobalOrdinal, class Node>
79  nAggregates_ = 0;
80 
81  vertex2AggId_ = LOVectorFactory::Build(map);
82  vertex2AggId_->putScalar(MUELU_UNAGGREGATED);
83 
84  procWinner_ = LOVectorFactory::Build(map);
85  procWinner_->putScalar(MUELU_UNASSIGNED);
86 
87  isRoot_ = Teuchos::ArrayRCP<bool>(map->getNodeNumElements(), false);
88 
89  // slow but safe, force TentativePFactory to build column map for P itself
90  aggregatesIncludeGhosts_ = true;
91  }
92 
94  template <class LocalOrdinal, class GlobalOrdinal, class Node>
96 
97  if (aggregateSizes_ != Teuchos::null && !forceRecompute) {
98 
99  return aggregateSizes_;
100 
101  } else {
102 
103  //invalidate previous sizes.
104  aggregateSizes_ = Teuchos::null;
105 
106  Teuchos::ArrayRCP<LO> aggregateSizes;
107  aggregateSizes = Teuchos::ArrayRCP<LO>(nAggregates_,0);
108  int myPid = vertex2AggId_->getMap()->getComm()->getRank();
109  Teuchos::ArrayRCP<LO> procWinner = procWinner_->getDataNonConst(0);
110  Teuchos::ArrayRCP<LO> vertex2AggId = vertex2AggId_->getDataNonConst(0);
111  LO size = procWinner.size();
112 
113  //for (LO i = 0; i < nAggregates_; ++i) aggregateSizes[i] = 0;
114  for (LO k = 0; k < size; ++k ) {
115  if (procWinner[k] == myPid) aggregateSizes[vertex2AggId[k]]++;
116  }
117 
118  if (cacheSizes)
119  aggregateSizes_ = aggregateSizes;
120 
121  return aggregateSizes;
122  }
123 
124  } //ComputeAggSizesNodes
125 
126  template <class LocalOrdinal, class GlobalOrdinal, class Node>
128  std::ostringstream out;
129  out << BaseClass::description();
130  out << "{nGlobalAggregates = " << GetNumGlobalAggregates() << "}";
131  return out.str();
132  }
133 
134  template <class LocalOrdinal, class GlobalOrdinal, class Node>
137 
138  if (verbLevel & Statistics1)
139  out0 << "Global number of aggregates: " << GetNumGlobalAggregates() << std::endl;
140  }
141 
142  template <class LocalOrdinal, class GlobalOrdinal, class Node>
144  LO nAggregates = GetNumAggregates();
145  GO nGlobalAggregates; MueLu_sumAll(vertex2AggId_->getMap()->getComm(), (GO)nAggregates, nGlobalAggregates);
146  return nGlobalAggregates;
147  }
148 
149  template <class LocalOrdinal, class GlobalOrdinal, class Node>
151  return vertex2AggId_->getMap();
152  }
153 
154 } //namespace MueLu
155 
156 #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.
size_type size() const
GlobalOrdinal GO
Print more statistics.
LocalOrdinal LO
Namespace for MueLu classes and methods.
Aggregates(const GraphBase &graph)
Standard constructor for Aggregates structure.
GO GetNumGlobalAggregates() const
Get global number of aggregates.
#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.
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=true, bool cacheSizes=false) const
Compute sizes of aggregates.