MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_RebalanceMapFactory_def.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// MueLu: A package for multigrid based preconditioning
6// Copyright 2013 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_REBALANCEMAPFACTORY_DEF_HPP_
47#define MUELU_REBALANCEMAPFACTORY_DEF_HPP_
48
50
51#include <Teuchos_Utils.hpp>
52
53#include "MueLu_Exceptions.hpp"
55#include "MueLu_Level.hpp"
56#include "MueLu_MasterList.hpp"
57#include "MueLu_Monitor.hpp"
58#include "MueLu_Utilities.hpp"
59
60namespace MueLu {
61
62 template <class LocalOrdinal, class GlobalOrdinal, class Node>
64 RCP<ParameterList> validParamList = rcp(new ParameterList());
65
66#define SET_VALID_ENTRY(name) validParamList->setEntry(name, MasterList::getEntry(name))
67 SET_VALID_ENTRY("repartition: use subcommunicators");
68#undef SET_VALID_ENTRY
69
70 // Information about map that is to be rebalanced
71 validParamList->set< std::string > ("Map name" , "", "Name of map to rebalanced.");
72 validParamList->set< RCP<const FactoryBase> >("Map factory", MueLu::NoFactory::getRCP(), "Generating factory of map to be rebalanced.");
73
74 // Importer object with rebalancing information
75 validParamList->set< RCP<const FactoryBase> >("Importer", Teuchos::null, "Factory of the importer object used for the rebalancing");
76
77 return validParamList;
78 }
79
80
81 template <class LocalOrdinal, class GlobalOrdinal, class Node>
83 const Teuchos::ParameterList & pL = GetParameterList();
84 std::string mapName = pL.get<std::string> ("Map name");
85 Teuchos::RCP<const FactoryBase> mapFactory = GetFactory ("Map factory");
86 currentLevel.DeclareInput(mapName,mapFactory.get(),this);
87
88 Input(currentLevel, "Importer");
89 } //DeclareInput()
90
91 template <class LocalOrdinal, class GlobalOrdinal, class Node>
93 FactoryMonitor m(*this, "Build", level);
94
95 //Teuchos::RCP<Teuchos::FancyOStream> fos = Teuchos::getFancyOStream(Teuchos::rcpFromRef(std::cout));
96
97 // extract data from Level object
98 const Teuchos::ParameterList & pL = GetParameterList();
99 std::string mapName = pL.get<std::string> ("Map name");
100 Teuchos::RCP<const FactoryBase> mapFactory = GetFactory ("Map factory");
101
102 RCP<const Import> rebalanceImporter = Get<RCP<const Import> >(level, "Importer");
103
104 if(rebalanceImporter != Teuchos::null) {
105 // input map (not rebalanced)
106 RCP<const Map> map = level.Get< RCP<const Map> >(mapName,mapFactory.get());
107
108 // create vector based on input map
109 // Note, that the map can be a part only of the full map stored in rebalanceImporter.getSourceMap()
110 RCP<Vector> v = VectorFactory::Build(map);
111 v->putScalar(1.0);
112
113 // create a new vector based on the full rebalanceImporter.getSourceMap()
114 // import the partial map information to the full source map
115 RCP<const Import> blowUpImporter = ImportFactory::Build(map, rebalanceImporter->getSourceMap());
116 RCP<Vector> pv = VectorFactory::Build(rebalanceImporter->getSourceMap());
117 pv->doImport(*v,*blowUpImporter,Xpetra::INSERT);
118
119 // do rebalancing using rebalanceImporter
120 RCP<Vector> ptv = VectorFactory::Build(rebalanceImporter->getTargetMap());
121 ptv->doImport(*pv,*rebalanceImporter,Xpetra::INSERT);
122
123 if (pL.get<bool>("repartition: use subcommunicators") == true)
124 ptv->replaceMap(ptv->getMap()->removeEmptyProcesses());
125
126 // reconstruct rebalanced partial map
127 Teuchos::ArrayRCP< const Scalar > ptvData = ptv->getData(0);
128 std::vector<GlobalOrdinal> localGIDs; // vector with GIDs that are stored on current proc
129
130 for (size_t k = 0; k < ptv->getLocalLength(); k++) {
131 if(ptvData[k] == 1.0) {
132 localGIDs.push_back(ptv->getMap()->getGlobalElement(k));
133 }
134 }
135
136 const Teuchos::ArrayView<const GlobalOrdinal> localGIDs_view(&localGIDs[0],localGIDs.size());
137
138 Teuchos::RCP<const Map> localGIDsMap = MapFactory::Build(
139 map->lib(),
140 Teuchos::OrdinalTraits<int>::invalid(),
141 localGIDs_view,
142 0, ptv->getMap()->getComm()); // use correct communicator here!
143
144 // store rebalanced partial map using the same name and generating factory as the original map
145 // in the level class
146 level.Set(mapName, localGIDsMap, mapFactory.get());
147 }
148 } //Build()
149
150} // end namespace MueLu
151
152#endif /* MUELU_REBALANCEMAPFACTORY_DEF_HPP_ */
#define SET_VALID_ENTRY(name)
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void DeclareInput(const std::string &ename, const FactoryBase *factory, const FactoryBase *requestedBy=NoFactory::get())
Callback from FactoryBase::CallDeclareInput() and FactoryBase::DeclareInput()
T & Get(const std::string &ename, const FactoryBase *factory=NoFactory::get())
Get data without decrementing associated storage counter (i.e., read-only access)....
void Set(const std::string &ename, const T &entry, const FactoryBase *factory=NoFactory::get())
static const RCP< const NoFactory > getRCP()
Static Get() functions.
void Build(Level &level) const
Build an object with this factory.
void DeclareInput(Level &level) const
Specifies the data that this class needs, and the factories that generate that data.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Namespace for MueLu classes and methods.