MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_Zoltan2Interface_decl.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_ZOLTAN2INTERFACE_DECL_HPP
47#define MUELU_ZOLTAN2INTERFACE_DECL_HPP
48
49#include "MueLu_ConfigDefs.hpp"
50
51#if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
52
53#include <Xpetra_Matrix.hpp>
54#include <Xpetra_MultiVectorFactory.hpp>
55#include <Xpetra_VectorFactory.hpp>
56
59
60#include "MueLu_Level_fwd.hpp"
63
64#if defined(HAVE_MUELU_ZOLTAN)
65#include "MueLu_ZoltanInterface.hpp"
66#endif
67
68namespace MueLu {
69
70
113 //FIXME: this class should not be templated
114 template <class Scalar,
117 class Node = DefaultNode>
119#undef MUELU_ZOLTAN2INTERFACE_SHORT
121
122 public:
123
125
126
129
131 virtual ~Zoltan2Interface() { }
133
134 RCP<const ParameterList> GetValidParameterList() const;
135
137
138 void DeclareInput(Level& currentLevel) const;
140
142
143 void Build(Level& currentLevel) const;
144
146
147 private:
148 RCP<ParameterList> defaultZoltan2Params;
149
150 }; //class Zoltan2Interface
151
152#ifdef HAVE_MUELU_EPETRA
153
154#if ((defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_OPENMP) || !defined(HAVE_TPETRA_INST_INT_INT))) || \
155 (!defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_SERIAL) || !defined(HAVE_TPETRA_INST_INT_INT))))
156
157#if defined(HAVE_MUELU_ZOLTAN)
158 // Stub partial specialization of Zoltan2Interface for EpetraNode
159 // Use ZoltanInterface instead of Zoltan2Interface
160 template<>
161 class Zoltan2Interface<double,int,int,Xpetra::EpetraNode> : public SingleLevelFactoryBase {
162 typedef double Scalar;
163 typedef int LocalOrdinal;
164 typedef int GlobalOrdinal;
165 typedef Xpetra::EpetraNode Node;
166#undef MUELU_ZOLTAN2INTERFACE_SHORT
168 public:
169 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType real_type;
170 typedef Xpetra::MultiVector<real_type,LO,GO,NO> RealValuedMultiVector;
171
173 level_ = rcp(new Level());
174 zoltanInterface_ = rcp(new ZoltanInterface());
175
176 level_->SetLevelID(1);
177 }
179 zoltanInterface_ = Teuchos::null;
180 level_ = Teuchos::null;
181 }
182 RCP<const ParameterList> GetValidParameterList() const {
183 RCP<ParameterList> validParamList = rcp(new ParameterList());
184
185 validParamList->set< RCP<const FactoryBase> > ("A", Teuchos::null, "Factory of the matrix A");
186 validParamList->set< RCP<const FactoryBase> > ("Coordinates", Teuchos::null, "Factory of the coordinates");
187 validParamList->set< RCP<const FactoryBase> > ("number of partitions", Teuchos::null, "Instance of RepartitionHeuristicFactory.");
188 validParamList->set< RCP<const ParameterList> > ("ParameterList", Teuchos::null, "Zoltan2 parameters");
189
190 return validParamList;
191 };
192 void DeclareInput(Level& currentLevel) const {
193 Input(currentLevel, "A");
194 Input(currentLevel, "number of partitions");
195 const ParameterList& pL = GetParameterList();
196 // We do this dance, because we don't want "ParameterList" to be marked as used.
197 // Is there a better way?
198 Teuchos::ParameterEntry entry = pL.getEntry("ParameterList");
199 RCP<const Teuchos::ParameterList> providedList = Teuchos::any_cast<RCP<const Teuchos::ParameterList> >(entry.getAny(false));
200 if (providedList != Teuchos::null && providedList->isType<std::string>("algorithm")) {
201 const std::string algo = providedList->get<std::string>("algorithm");
202 if (algo == "multijagged" || algo == "rcb")
203 Input(currentLevel, "Coordinates");
204 } else
205 Input(currentLevel, "Coordinates");
206 };
207 void Build(Level& currentLevel) const {
208 this->GetOStream(Warnings0) << "Tpetra does not support <double,int,int,EpetraNode> instantiation, "
209 "switching Zoltan2Interface to ZoltanInterface" << std::endl;
210
211 // Put the data into a fake level
212 level_->Set("A", Get<RCP<Matrix> > (currentLevel, "A"));
213 level_->Set("Coordinates", Get<RCP<RealValuedMultiVector> >(currentLevel, "Coordinates"));
214 level_->Set("number of partitions", currentLevel.Get<GO>("number of partitions"));
215
216 level_->Request("Partition", zoltanInterface_.get());
217 zoltanInterface_->Build(*level_);
218
219 RCP<Xpetra::Vector<GO,LO,GO,NO> > decomposition;
220 level_->Get("Partition", decomposition, zoltanInterface_.get());
221 Set(currentLevel, "Partition", decomposition);
222 };
223
224 private:
225 RCP<Level> level_; // fake Level
226 RCP<ZoltanInterface> zoltanInterface_;
227 };
228#else
229 // Stub partial specialization of Zoltan2Interface for EpetraNode
230 template<>
231 class Zoltan2Interface<double,int,int,Xpetra::EpetraNode> : public SingleLevelFactoryBase {
232 public:
233 Zoltan2Interface() { throw Exceptions::RuntimeError("Tpetra does not support <double,int,int,EpetraNode> instantiation"); }
234 virtual ~Zoltan2Interface() { }
235 RCP<const ParameterList> GetValidParameterList() const { return Teuchos::null; };
236 void DeclareInput(Level& level) const {};
237 void Build(Level &level) const {};
238 };
239#endif // HAVE_MUELU_ZOLTAN
240
241#endif
242
243#endif // HAVE_MUELU_EPETRA
244
245} //namespace MueLu
246
247#define MUELU_ZOLTAN2INTERFACE_SHORT
248#endif //if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
249
250#endif // MUELU_ZOLTAN2INTERFACE_DECL_HPP
Kokkos::Compat::KokkosSerialWrapperNode EpetraNode
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Exception throws to report errors in the internal logical of the program.
void Input(Level &level, const std::string &varName) const
T Get(Level &level, const std::string &varName) const
void Set(Level &level, const std::string &varName, const T &data) const
Class that holds all level-specific information.
T & Get(const std::string &ename, const FactoryBase *factory=NoFactory::get())
Get data without decrementing associated storage counter (i.e., read-only access)....
virtual const Teuchos::ParameterList & GetParameterList() const
Base class for factories that use one level (currentLevel).
Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly=0) const
Get an output stream for outputting the input message type.
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.
Interface to Zoltan2 library.
void DeclareInput(Level &currentLevel) 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.
void Build(Level &currentLevel) const
Build an object with this factory.
Interface to Zoltan library.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
@ Warnings0
Important warning messages (one line)