MueLu  Version of the Day
MueLu_HierarchyUtils_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_HIERARCHYUTILS_DEF_HPP
47 #define MUELU_HIERARCHYUTILS_DEF_HPP
48 
49 #include "Teuchos_ScalarTraits.hpp"
50 
51 #include <Xpetra_Matrix.hpp>
52 #include <Xpetra_Operator.hpp>
53 
56 #include "MueLu_SmootherBase.hpp"
57 #include "MueLu_SmootherFactory.hpp"
58 #include "MueLu_FactoryManager.hpp"
59 
60 //TODO/FIXME: DeclareInput(, **this**) cannot be used here
61 #ifdef HAVE_MUELU_INTREPID2
62 #include "Kokkos_DynRankView.hpp"
63 #endif
64 
65 namespace MueLu {
66 
67 
68  // Adds the following non-serializable data (A,P,R,Nullspace,Coordinates) from level-specific sublist nonSerialList,
69  // calling AddNewLevel as appropriate.
70  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
72  typedef typename Xpetra::MultiVector<typename Teuchos::ScalarTraits<Scalar>::magnitudeType,
73  LocalOrdinal, GlobalOrdinal, Node> realvaluedmultivector_type;
74 
75  for (ParameterList::ConstIterator it = paramList.begin(); it != paramList.end(); it++) {
76  const std::string& levelName = it->first;
77  // Check for mach of the form "level X" where X is a positive integer
78  if (paramList.isSublist(levelName) && levelName.find("level ") == 0 && levelName.size() > 6) {
79  int levelID = strtol(levelName.substr(6).c_str(), 0, 0);
80  if (levelID > 0)
81  {
82  // Do enough level adding so we can be sure to add the data to the right place
83  for (int i = H.GetNumLevels(); i <= levelID; i++)
84  H.AddNewLevel();
85  }
86  RCP<Level> level = H.GetLevel(levelID);
87 
88  RCP<FactoryManager> M = Teuchos::rcp_dynamic_cast<FactoryManager>(HM.GetFactoryManager(levelID));
89  TEUCHOS_TEST_FOR_EXCEPTION(M.is_null(), Exceptions::InvalidArgument, "MueLu::Utils::AddNonSerializableDataToHierarchy: cannot get FactoryManager");
90 
91  // Grab the level sublist & loop over parameters
92  const ParameterList& levelList = paramList.sublist(levelName);
93  for (ParameterList::ConstIterator it2 = levelList.begin(); it2 != levelList.end(); it2++) {
94  const std::string& name = it2->first;
95  TEUCHOS_TEST_FOR_EXCEPTION(name != "A" && name != "P" && name != "R" && name != "K" && name != "M" &&
96  name != "Nullspace" && name != "Coordinates" && name != "pcoarsen: element to node map" &&
98  "MueLu::Utils::AddNonSerializableDataToHierarchy: parameter list contains unknown data type");
99 
100  if (name == "A") {
101  level->Set(name, Teuchos::getValue<RCP<Matrix > > (it2->second),NoFactory::get());
102  M->SetFactory(name, NoFactory::getRCP()); // TAW: not sure about this: be aware that this affects all levels
103  // However, A is accessible through NoFactory anyway, so it should
104  // be fine here.
105  }
106  else if(name == "P" || name == "R" || name == "K" || name == "M") {
108  level->Set(name, Teuchos::getValue<RCP<Matrix > > (it2->second), NoFactory::get());
109  }
110  else if (name == "Nullspace")
111  {
113  level->Set(name, Teuchos::getValue<RCP<MultiVector > >(it2->second), NoFactory::get());
114  //M->SetFactory(name, NoFactory::getRCP()); // TAW: generally it is a bad idea to overwrite the factory manager data here
115  // One should do this only in very special cases
116  }
117  else if(name == "Coordinates") //Scalar of Coordinates MV is always double
118  {
120  level->Set(name, Teuchos::getValue<RCP<realvaluedmultivector_type> >(it2->second), NoFactory::get());
121  //M->SetFactory(name, NoFactory::getRCP()); // TAW: generally it is a bad idea to overwrite the factory manager data here
122  }
123 #ifdef HAVE_MUELU_INTREPID2
124  else if (name == "pcoarsen: element to node map")
125  {
127  level->Set(name, Teuchos::getValue<RCP<Kokkos::DynRankView<LocalOrdinal,typename Node::device_type> > >(it2->second), NoFactory::get());
128  }
129 #endif
130  else
131 #ifdef HAVE_MUELU_MATLAB
132  {
133  //Custom variable for Muemex
134  size_t typeNameStart = name.find_first_not_of(' ');
135  size_t typeNameEnd = name.find(' ', typeNameStart);
136  std::string typeName = name.substr(typeNameStart, typeNameEnd - typeNameStart);
137  std::transform(typeName.begin(), typeName.end(), typeName.begin(), ::tolower);
138  level->AddKeepFlag(name, NoFactory::get(), MueLu::UserData);
139  if(typeName == "matrix")
140  level->Set(name, Teuchos::getValue<RCP<Matrix> >(it2->second), NoFactory::get());
141  else if(typeName == "multivector")
142  level->Set(name, Teuchos::getValue<RCP<MultiVector> >(it2->second), NoFactory::get());
143  else if(typeName == "map")
144  level->Set(name, Teuchos::getValue<RCP<Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > >(it2->second), NoFactory::get());
145  else if(typeName == "ordinalvector")
146  level->Set(name, Teuchos::getValue<RCP<Xpetra::Vector<LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node> > >(it2->second), NoFactory::get());
147  else if(typeName == "scalar")
148  level->Set(name, Teuchos::getValue<Scalar>(it2->second), NoFactory::get());
149  else if(typeName == "double")
150  level->Set(name, Teuchos::getValue<double>(it2->second), NoFactory::get());
151  else if(typeName == "complex")
152  level->Set(name, Teuchos::getValue<std::complex<double> >(it2->second), NoFactory::get());
153  else if(typeName == "int")
154  level->Set(name, Teuchos::getValue<int>(it2->second), NoFactory::get());
155  else if(typeName == "string")
156  level->Set(name, Teuchos::getValue<std::string>(it2->second), NoFactory::get());
157  }
158 #else
159  {
160  throw std::runtime_error("Invalid non-serializable data on list");
161  }
162 #endif
163  }
164  } else if (paramList.isSublist(levelName) && levelName.find("user data") != std::string::npos) {
165  // So far only put data on level 0
166  int levelID = 0;
167  RCP<Level> level = H.GetLevel(levelID);
168 
169  RCP<FactoryManager> M = Teuchos::rcp_dynamic_cast<FactoryManager>(HM.GetFactoryManager(levelID));
170  TEUCHOS_TEST_FOR_EXCEPTION(M.is_null(), Exceptions::InvalidArgument, "MueLu::Utils::AddNonSerializableDataToHierarchy: cannot get FactoryManager");
171 
172  // Grab the user data sublist & loop over parameters
173  const ParameterList& userList = paramList.sublist(levelName);
174  for (ParameterList::ConstIterator it2 = userList.begin(); it2 != userList.end(); it2++) {
175  const std::string& name = it2->first;
176  TEUCHOS_TEST_FOR_EXCEPTION(name != "P" && name != "R" &&
177  name != "Nullspace" && name != "Coordinates" &&
179  "MueLu::Utils::AddNonSerializableDataToHierarchy: user data parameter list contains unknown data type!");
180  if( name == "P" || name == "R") {
182  level->Set(name, Teuchos::getValue<RCP<Matrix > > (it2->second), NoFactory::get());
183  } else if (name == "Nullspace") {
185  level->Set(name, Teuchos::getValue<RCP<MultiVector > >(it2->second), NoFactory::get());
186  //M->SetFactory(name, NoFactory::getRCP()); // TAW: generally it is a bad idea to overwrite the factory manager data here
187  // One should do this only in very special cases
188  } else if(name == "Coordinates") {//Scalar of Coordinates MV is always double
190  level->Set(name, Teuchos::getValue<RCP<realvaluedmultivector_type> >(it2->second), NoFactory::get());
191  level->print(std::cout, MueLu::VERB_EXTREME);
192  //M->SetFactory(name, NoFactory::getRCP()); // TAW: generally it is a bad idea to overwrite the factory manager data here
193  } else {
194  //Custom variable
195  size_t typeNameStart = name.find_first_not_of(' ');
196  size_t typeNameEnd = name.find(' ', typeNameStart);
197  std::string typeName = name.substr(typeNameStart, typeNameEnd - typeNameStart);
198  size_t varNameStart = name.find_first_not_of(' ', typeNameEnd);
199  std::string varName = name.substr(varNameStart, name.size());
200  std::transform(typeName.begin(), typeName.end(), typeName.begin(), ::tolower);
201  level->AddKeepFlag(varName, NoFactory::get(), MueLu::UserData);
202  if(typeName == "matrix")
203  level->Set(varName, Teuchos::getValue<RCP<Matrix> >(it2->second), NoFactory::get());
204  else if(typeName == "multivector")
205  level->Set(varName, Teuchos::getValue<RCP<MultiVector> >(it2->second), NoFactory::get());
206  else if(typeName == "map")
207  level->Set(varName, Teuchos::getValue<RCP<Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > >(it2->second), NoFactory::get());
208  else if(typeName == "ordinalvector")
209  level->Set(varName, Teuchos::getValue<RCP<Xpetra::Vector<LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node> > >(it2->second), NoFactory::get());
210  else if(typeName == "scalar")
211  level->Set(varName, Teuchos::getValue<Scalar>(it2->second), NoFactory::get());
212  else if(typeName == "double")
213  level->Set(varName, Teuchos::getValue<double>(it2->second), NoFactory::get());
214  else if(typeName == "complex")
215  level->Set(varName, Teuchos::getValue<std::complex<double> >(it2->second), NoFactory::get());
216  else if(typeName == "int")
217  level->Set(varName, Teuchos::getValue<int>(it2->second), NoFactory::get());
218  else if(typeName == "string")
219  level->Set(varName, Teuchos::getValue<std::string>(it2->second), NoFactory::get());
220  else if(typeName == "array<go>")
221  level->Set(varName, Teuchos::getValue<Array<GlobalOrdinal> > (it2->second), NoFactory::get());
222  else if(typeName == "array<lo>")
223  level->Set(varName, Teuchos::getValue<Array<LocalOrdinal> >(it2->second), NoFactory::get());
224  else if(typeName == "arrayrcp<lo>")
225  level->Set(varName, Teuchos::getValue<ArrayRCP<LocalOrdinal> >(it2->second), NoFactory::get());
226  else if(typeName == "arrayrcp<go>")
227  level->Set(varName, Teuchos::getValue<ArrayRCP<GlobalOrdinal> >(it2->second), NoFactory::get());
228  else
229  throw std::runtime_error("Invalid non-serializable data on list");
230  }
231  }
232  }
233  }
234  }
235 } // namespace MueLu
236 
237 #define MUELU_HIERARCHY_UTILS_SHORT
238 #endif // MUELU_HIERARCHYHELPERS_DEF_HPP
This class specifies the default factory that should generate some data on a Level if the data does n...
RCP< Level > & GetLevel(const int levelID=0)
Retrieve a certain level from hierarchy.
static void AddNonSerializableDataToHierarchy(HierarchyManager &HM, Hierarchy &H, const ParameterList &nonSerialList)
ConstIterator begin() const
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
bool isSublist(const std::string &name) const
VERB_EXTREME
void AddNewLevel()
Add a new level at the end of the hierarchy.
User data are always kept. This flag is set automatically when Level::Set("data", data) is used...
std::string tolower(const std::string &str)
Namespace for MueLu classes and methods.
bool IsParamMuemexVariable(const std::string &name)
RCP< FactoryManagerBase > GetFactoryManager(int levelID) const
static const NoFactory * get()
bool is_null() const
ConstIterator end() const
params_t::ConstIterator ConstIterator
void print(std::ostream &out, const VerbLevel verbLevel=Default) const
Printing method.
void AddKeepFlag(const std::string &ename, const FactoryBase *factory=NoFactory::get(), KeepType keep=MueLu::Keep)
bool IsParamValidVariable(const std::string &name)
void Set(const std::string &ename, const T &entry, const FactoryBase *factory=NoFactory::get())
void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Set Factory.
ParameterList & sublist(const std::string &name, bool mustAlreadyExist=false, const std::string &docString="")
Provides methods to build a multigrid hierarchy and apply multigrid cycles.
std::string typeName(const T &t)
Exception throws to report invalid user entry.
static const RCP< const NoFactory > getRCP()
Static Get() functions.