MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_NodePartitionInterface_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_NODEPARTITIONINTERFACE_DEF_HPP
47#define MUELU_NODEPARTITIONINTERFACE_DEF_HPP
48
49#include <sstream>
50#include <set>
51
53#if defined(HAVE_MPI)
54#include <Teuchos_Utils.hpp>
55#include <Teuchos_DefaultMpiComm.hpp>
56#include <Teuchos_OpaqueWrapper.hpp>
57
58#include "MueLu_Level.hpp"
59#include "MueLu_Exceptions.hpp"
60#include "MueLu_Monitor.hpp"
61#include "MueLu_Utilities.hpp"
62#include "MueLu_MasterList.hpp"
63
64namespace MueLu {
65
66 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
68
69 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
71 RCP<ParameterList> validParamList = rcp(new ParameterList());
72#define SET_VALID_ENTRY(name) validParamList->setEntry(name, MasterList::getEntry(name))
73 SET_VALID_ENTRY("repartition: node id");
74#undef SET_VALID_ENTRY
75
76 validParamList->set< RCP<const FactoryBase> > ("A", Teuchos::null, "Factory of the matrix A");
77 validParamList->set< RCP<const FactoryBase> > ("number of partitions", Teuchos::null, "Instance of RepartitionHeuristicFactory.");
78 validParamList->set< RCP<const FactoryBase> > ("Node Comm", Teuchos::null, "Generating factory of the node level communicator");
79
80 // We don't really need this, but we might need it on coarser levels
81 validParamList->set< RCP<const FactoryBase> > ("Coordinates", Teuchos::null, "Factory of the coordinates");
82 return validParamList;
83 }
84
85
86 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
88 Input(currentLevel, "A");
89 Input(currentLevel, "number of partitions");
90 Input(currentLevel, "Node Comm");
91 Input(currentLevel, "Coordinates");
92 }
93
94 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
96 FactoryMonitor m(*this, "Build", level);
97 RCP<Matrix> A = Get<RCP<Matrix> >(level, "A");
98 RCP<const Map> rowMap = A->getRowMap();
99
100 int numParts = Get<int>(level, "number of partitions");
101 if (numParts == 1 || numParts == -1) {
102 // Single processor, decomposition is trivial: all zeros
103 RCP<Xpetra::Vector<GO,LO,GO,NO> > decomposition = Xpetra::VectorFactory<GO, LO, GO, NO>::Build(rowMap, true);
104 Set(level, "Partition", decomposition);
105 return;
106 }
107
108 // Let us repartition nodally
109 RCP<const Teuchos::Comm<int> > NodeComm = Get< RCP<const Teuchos::Comm<int> > >(level, "Node Comm");
110 TEUCHOS_TEST_FOR_EXCEPTION(NodeComm.is_null(), Exceptions::RuntimeError, "MueLu::NodePartitionInterface::Build(): NodeComm is null.");
111
112 // Get the rank (in current comm) of rank 0 in my NodeComm
113 int nodeZeroRank =A->getMap()->getComm()->getRank();
114 Teuchos::broadcast<int,int>(*NodeComm,0,Teuchos::inOutArg(nodeZeroRank));
115
116 // A "Partition" from a *Interface is supposed to be is a vector of length # of my rows with the partition number to which the unknown is assigned
117 // BUT, since we're bypassing remap for NodePartition, we'll return a *rank* of the guy who gets each unknown (which is what remap outputs).
118 RCP<Xpetra::Vector<GO,LO,GO,NO> > decomposition = Xpetra::VectorFactory<GO,LO,GO,NO>::Build(rowMap, false);
119 decomposition->putScalar(Teuchos::as<GO>(nodeZeroRank));
120
121 Set(level, "Partition", decomposition);
122
123 }
124
125} //namespace MueLu
126
127#endif //if defined(HAVE_MPI)
128
129#endif // MUELU_NODEPARTITIONINTERFACE_DEF_HPP
#define SET_VALID_ENTRY(name)
Exception throws to report errors in the internal logical of the program.
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &currentLevel) const
Build an object with this factory.
Namespace for MueLu classes and methods.