MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_MasterList.cpp
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 #include <Teuchos_XMLParameterListCoreHelpers.hpp>
47 
48 #include "MueLu_Exceptions.hpp"
49 #include "MueLu_MasterList.hpp"
50 
51 namespace MueLu {
52 
53  Teuchos::RCP<const Teuchos::ParameterList> MasterList::List() {
54  if (masterList_.is_null()) {
55  masterList_ = Teuchos::getParametersFromXmlString(stringList_);
56  }
57 
58  return masterList_;
59  }
60 
61  Teuchos::RCP<Teuchos::ParameterList> MasterList::GetProblemSpecificList(std::string const & problemType) {
62 
63  if ( (problemType != problemType_) || problemSpecificList_.is_null() ) {
64  if (DefaultProblemTypeLists_.find(problemType) != DefaultProblemTypeLists_.end()) {
65  problemType_ = problemType;
66  problemSpecificList_ = Teuchos::getParametersFromXmlString(DefaultProblemTypeLists_[problemType]);
67  } else {
68  //TODO provide valid problem types
69  TEUCHOS_TEST_FOR_EXCEPTION(true, MueLu::Exceptions::RuntimeError, "Invalid problem type " << problemType << ".");
70  }
71  }
72  return problemSpecificList_;
73  }
74 
75  std::string MasterList::interpretParameterName(const std::string& name, const std::string& value) {
76 
77  // used to concatenate the return string
78  std::stringstream ss;
79 
80  // put in short cuts here!
81 
82  if (name == "verbosity") {
83  std::string verb = "none";
84  if (value == "\"0\"") verb = "none";
85  if (value == "\"1\"" || value == "\"2\"" || value == "\"3\"") verb = "low";
86  if (value == "\"4\"" || value == "\"5\"" || value == "\"6\"") verb = "medium";
87  if (value == "\"7\"" || value == "\"8\"") verb = "high";
88  if (value == "\"9\"") verb = "extreme";
89  if (value == "\"10\"") verb = "test";
90  verb = "\"" + verb + "\"";
91  ss << "<Parameter name=\"verbosity\" type=\"string\" value=" << verb << "/>";
92  return ss.str();
93  }
94 
95  if (name == "cycle type") {
96  std::stringstream temp1; temp1 << "\"" << "MGV" << "\"";
97  std::stringstream temp2; temp2 << "\"" << "MGV" << "\"";
98  if (value == temp1.str() ) { ss << "<Parameter name=\"cycle type\" type=\"string\" value=\"V\"/>"; }
99  else if (value == temp2.str()) { ss << "<Parameter name=\"cycle type\" type=\"string\" value=\"W\"/>"; }
100  else TEUCHOS_TEST_FOR_EXCEPTION(true, MueLu::Exceptions::RuntimeError, "MasterList::interpretParameterName, Line " << __LINE__ << ". "
101  << "The parameter " << value << " is not supported by MueLu.");
102  return ss.str();
103  }
104 
105  // energy minimization is enabled
106  if (name == "multigrid algorithm") {
107  std::stringstream temp; temp << "\"" << "1" << "\"";
108  if (value == temp.str() ) { ss << "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"pg\"/>"; return ss.str(); }
109  }
110 
111  if (name == "repartition: enable") {
112  std::stringstream temp1; temp1 << "\"" << "1" << "\"";
113  if (value == temp1.str()) {
114  RCP<Teuchos::FancyOStream> out = Teuchos::fancyOStream(Teuchos::rcpFromRef(std::cout));
115  *out << "WARNING: repartitioning in MueLu is different to MLs. Please refer to the MueLu users Manual for more information." << std::endl;
116  }
117  }
118 
119  // put in auto-generated code here
120 
121 
122  if (name == "number of equations") { ss << "<Parameter name=\"number of equations\" type=\"int\" value=" << value << "/>"; return ss.str(); }
123  if (name == "max levels") { ss << "<Parameter name=\"max levels\" type=\"int\" value=" << value << "/>"; return ss.str(); }
124  if (name == "coarse grid correction scaling factor") { ss << "<Parameter name=\"coarse grid correction scaling factor\" type=\"double\" value=" << value << "/>"; return ss.str(); }
125  if (name == "fuse prolongation and update") { ss << "<Parameter name=\"fuse prolongation and update\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
126  if (name == "problem: symmetric") { ss << "<Parameter name=\"problem: symmetric\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
127  if (name == "hierarchy label") { ss << "<Parameter name=\"hierarchy label\" type=\"string\" value=" << value << "/>"; return ss.str(); }
128  if (name == "aggregation: drop tol") { ss << "<Parameter name=\"aggregation: drop tol\" type=\"double\" value=" << value << "/>"; return ss.str(); }
129  if (name == "print initial parameters") { ss << "<Parameter name=\"print initial parameters\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
130  if (name == "print unused parameters") { ss << "<Parameter name=\"print unused parameters\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
131  if (name == "sa: damping factor") { ss << "<Parameter name=\"sa: damping factor\" type=\"double\" value=" << value << "/>"; return ss.str(); }
132  if (name == "sa: eigenvalue estimate num iterations") { ss << "<Parameter name=\"sa: eigenvalue estimate num iterations\" type=\"int\" value=" << value << "/>"; return ss.str(); }
133  if (name == "pcoarsen: element") { ss << "<Parameter name=\"pcoarsen: element\" type=\"string\" value=" << value << "/>"; return ss.str(); }
134  if (name == "pcoarsen: schedule") { ss << "<Parameter name=\"pcoarsen: schedule\" type=\"string\" value=" << value << "/>"; return ss.str(); }
135  if (name == "pcoarsen: hi basis") { ss << "<Parameter name=\"pcoarsen: hi basis\" type=\"string\" value=" << value << "/>"; return ss.str(); }
136  if (name == "pcoarsen: lo basis") { ss << "<Parameter name=\"pcoarsen: lo basis\" type=\"string\" value=" << value << "/>"; return ss.str(); }
137  if (name == "smoother: neighborhood type") { ss << "<Parameter name=\"smoother: neighborhood type\" type=\"string\" value=" << value << "/>"; return ss.str(); }
138  if (name == "tentative: calculate qr") { ss << "<Parameter name=\"tentative: calculate qr\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
139  if (name == "repartition: enable") { ss << "<Parameter name=\"repartition: enable\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
140  if (name == "repartition: start level") { ss << "<Parameter name=\"repartition: start level\" type=\"int\" value=" << value << "/>"; return ss.str(); }
141  if (name == "repartition: node repartition level") { ss << "<Parameter name=\"repartition: node repartition level\" type=\"int\" value=" << value << "/>"; return ss.str(); }
142  if (name == "repartition: node id") { ss << "<Parameter name=\"repartition: node id\" type=\"int\" value=" << value << "/>"; return ss.str(); }
143  if (name == "repartition: min rows per proc") { ss << "<Parameter name=\"repartition: min rows per proc\" type=\"int\" value=" << value << "/>"; return ss.str(); }
144  if (name == "repartition: max imbalance") { ss << "<Parameter name=\"repartition: max imbalance\" type=\"double\" value=" << value << "/>"; return ss.str(); }
145  if (name == "use external multigrid package") { ss << "<Parameter name=\"use external multigrid package\" type=\"string\" value=" << value << "/>"; return ss.str(); }
146  if (name == "refmaxwell: mode") { ss << "<Parameter name=\"refmaxwell: mode\" type=\"string\" value=" << value << "/>"; return ss.str(); }
147  if (name == "refmaxwell: disable addon") { ss << "<Parameter name=\"refmaxwell: disable addon\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
148  if (name == "refmaxwell: use as preconditioner") { ss << "<Parameter name=\"refmaxwell: use as preconditioner\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
149  if (name == "refmaxwell: dump matrices") { ss << "<Parameter name=\"refmaxwell: dump matrices\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
150  if (name == "refmaxwell: subsolves on subcommunicators") { ss << "<Parameter name=\"refmaxwell: subsolves on subcommunicators\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
151  if (name == "refmaxwell: ratio AH / A22 subcommunicators") { ss << "<Parameter name=\"refmaxwell: ratio AH / A22 subcommunicators\" type=\"double\" value=" << value << "/>"; return ss.str(); }
152  return "";
153  }
154 
155  Teuchos::RCP<Teuchos::ParameterList> MasterList::masterList_ = Teuchos::null;
156  Teuchos::RCP<Teuchos::ParameterList> MasterList::problemSpecificList_ = Teuchos::null;
157  std::string MasterList::problemType_ = "unknown";
158  const std::string MasterList::stringList_ =
159 "<ParameterList name=\"MueLu\">"
160  "<Parameter name=\"problem: type\" type=\"string\" value=\"unknown\"/>"
161  "<Parameter name=\"verbosity\" type=\"string\" value=\"high\"/>"
162  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
163  "<Parameter name=\"max levels\" type=\"int\" value=\"10\"/>"
164  "<Parameter name=\"cycle type\" type=\"string\" value=\"V\"/>"
165  "<Parameter name=\"coarse grid correction scaling factor\" type=\"double\" value=\"1.0\"/>"
166  "<Parameter name=\"fuse prolongation and update\" type=\"bool\" value=\"false\"/>"
167  "<Parameter name=\"problem: symmetric\" type=\"bool\" value=\"true\"/>"
168  "<Parameter name=\"xml parameter file\" type=\"string\" value=\"\"/>"
169  "<Parameter name=\"parameterlist: syntax\" type=\"string\" value=\"muelu\"/>"
170  "<Parameter name=\"hierarchy label\" type=\"string\" value=\"\"/>"
171  "<ParameterList name=\"matvec params\"/>"
172  "<Parameter name=\"smoother: pre or post\" type=\"string\" value=\"both\"/>"
173  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
174  "<Parameter name=\"smoother: pre type\" type=\"string\" value=\"RELAXATION\"/>"
175  "<Parameter name=\"smoother: post type\" type=\"string\" value=\"RELAXATION\"/>"
176  "<ParameterList name=\"smoother: params\"/>"
177  "<ParameterList name=\"smoother: pre params\"/>"
178  "<ParameterList name=\"smoother: post params\"/>"
179  "<Parameter name=\"smoother: overlap\" type=\"int\" value=\"0\"/>"
180  "<Parameter name=\"smoother: pre overlap\" type=\"int\" value=\"0\"/>"
181  "<Parameter name=\"smoother: post overlap\" type=\"int\" value=\"0\"/>"
182  "<Parameter name=\"coarse: max size\" type=\"int\" value=\"2000\"/>"
183  "<Parameter name=\"coarse: type\" type=\"string\" value=\"SuperLU\"/>"
184  "<ParameterList name=\"coarse: params\"/>"
185  "<Parameter name=\"coarse: overlap\" type=\"int\" value=\"0\"/>"
186  "<Parameter name=\"aggregation: type\" type=\"string\" value=\"uncoupled\"/>"
187  "<Parameter name=\"aggregation: mode\" type=\"string\" value=\"uncoupled\"/>"
188  "<Parameter name=\"aggregation: ordering\" type=\"string\" value=\"natural\"/>"
189  "<Parameter name=\"aggregation: drop scheme\" type=\"string\" value=\"classical\"/>"
190  "<Parameter name=\"aggregation: drop tol\" type=\"double\" value=\"0.0\"/>"
191  "<Parameter name=\"aggregation: min agg size\" type=\"int\" value=\"2\"/>"
192  "<Parameter name=\"aggregation: max agg size\" type=\"int\" value=\"-1\"/>"
193  "<Parameter name=\"aggregation: brick x size\" type=\"int\" value=\"2\"/>"
194  "<Parameter name=\"aggregation: brick y size\" type=\"int\" value=\"2\"/>"
195  "<Parameter name=\"aggregation: brick z size\" type=\"int\" value=\"2\"/>"
196  "<Parameter name=\"aggregation: max selected neighbors\" type=\"int\" value=\"0\"/>"
197  "<Parameter name=\"aggregation: Dirichlet threshold\" type=\"double\" value=\"0.0\"/>"
198  "<Parameter name=\"aggregation: deterministic\" type=\"bool\" value=\"false\"/>"
199  "<Parameter name=\"aggregation: phase 1 algorithm\" type=\"string\" value=\"Serial\"/>"
200  "<Parameter name=\"aggregation: enable phase 1\" type=\"bool\" value=\"true\"/>"
201  "<Parameter name=\"aggregation: enable phase 2a\" type=\"bool\" value=\"true\"/>"
202  "<Parameter name=\"aggregation: enable phase 2b\" type=\"bool\" value=\"true\"/>"
203  "<Parameter name=\"aggregation: enable phase 3\" type=\"bool\" value=\"true\"/>"
204  "<Parameter name=\"aggregation: error on nodes with no on-rank neighbors\" type=\"bool\" value=\"false\"/>"
205  "<Parameter name=\"aggregation: phase3 avoid singletons\" type=\"bool\" value=\"false\"/>"
206  "<Parameter name=\"aggregation: allow empty prolongator columns\" type=\"bool\" value=\"false\"/>"
207  "<Parameter name=\"aggregation: preserve Dirichlet points\" type=\"bool\" value=\"false\"/>"
208  "<Parameter name=\"aggregation: allow user-specified singletons\" type=\"bool\" value=\"false\"/>"
209  "<Parameter name=\"aggregation: use interface aggregation\" type=\"bool\" value=\"false\"/>"
210  "<Parameter name=\"aggregation: export visualization data\" type=\"bool\" value=\"false\"/>"
211  "<Parameter name=\"aggregation: output filename\" type=\"string\" value=\"\"/>"
212  "<Parameter name=\"aggregation: output file: time step\" type=\"int\" value=\"0\"/>"
213  "<Parameter name=\"aggregation: output file: iter\" type=\"int\" value=\"0\"/>"
214  "<Parameter name=\"aggregation: output file: agg style\" type=\"string\" value=\"Point Cloud\"/>"
215  "<Parameter name=\"aggregation: output file: fine graph edges\" type=\"bool\" value=\"false\"/>"
216  "<Parameter name=\"aggregation: output file: coarse graph edges\" type=\"bool\" value=\"false\"/>"
217  "<Parameter name=\"aggregation: output file: build colormap\" type=\"bool\" value=\"false\"/>"
218  "<ParameterList name=\"aggregation: params\"/>"
219  "<ParameterList name=\"strength-of-connection: params\"/>"
220  "<Parameter name=\"aggregation: mesh layout\" type=\"string\" value=\"Global Lexicographic\"/>"
221  "<Parameter name=\"aggregation: output type\" type=\"string\" value=\"Aggregates\"/>"
222  "<Parameter name=\"aggregation: coarsening rate\" type=\"string\" value=\"{3}\"/>"
223  "<Parameter name=\"aggregation: number of spatial dimensions\" type=\"int\" value=\"3\"/>"
224  "<Parameter name=\"aggregation: coarsening order\" type=\"int\" value=\"0\"/>"
225  "<ParameterList name=\"export data\"/>"
226  "<Parameter name=\"print initial parameters\" type=\"bool\" value=\"true\"/>"
227  "<Parameter name=\"print unused parameters\" type=\"bool\" value=\"true\"/>"
228  "<Parameter name=\"transpose: use implicit\" type=\"bool\" value=\"false\"/>"
229  "<Parameter name=\"restriction: scale nullspace\" type=\"bool\" value=\"false\"/>"
230  "<Parameter name=\"use kokkos refactor\" type=\"bool\" value=\"false\"/>"
231  "<Parameter name=\"synchronize factory timers\" type=\"bool\" value=\"false\"/>"
232  "<Parameter name=\"rap: triple product\" type=\"bool\" value=\"false\"/>"
233  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
234  "<Parameter name=\"toggle: mode\" type=\"string\" value=\"semicoarsen\"/>"
235  "<Parameter name=\"semicoarsen: coarsen rate\" type=\"int\" value=\"3\"/>"
236  "<Parameter name=\"semicoarsen: number of levels\" type=\"int\" value=\"3\"/>"
237  "<Parameter name=\"linedetection: orientation\" type=\"string\" value=\"vertical\"/>"
238  "<Parameter name=\"linedetection: num layers\" type=\"int\" value=\"-1\"/>"
239  "<Parameter name=\"sa: damping factor\" type=\"double\" value=\"1.33\"/>"
240  "<Parameter name=\"sa: use filtered matrix\" type=\"bool\" value=\"true\"/>"
241  "<Parameter name=\"sa: calculate eigenvalue estimate\" type=\"bool\" value=\"false\"/>"
242  "<Parameter name=\"sa: eigenvalue estimate num iterations\" type=\"int\" value=\"10\"/>"
243  "<Parameter name=\"interp: interpolation order\" type=\"int\" value=\"1\"/>"
244  "<Parameter name=\"interp: build coarse coordinates\" type=\"bool\" value=\"true\"/>"
245  "<ParameterList name=\"transfer: params\"/>"
246  "<Parameter name=\"pcoarsen: element\" type=\"string\" value=\"\"/>"
247  "<Parameter name=\"pcoarsen: schedule\" type=\"string\" value=\"\"/>"
248  "<Parameter name=\"pcoarsen: hi basis\" type=\"string\" value=\"\"/>"
249  "<Parameter name=\"pcoarsen: lo basis\" type=\"string\" value=\"\"/>"
250  "<Parameter name=\"smoother: neighborhood type\" type=\"string\" value=\"\"/>"
251  "<Parameter name=\"filtered matrix: use lumping\" type=\"bool\" value=\"true\"/>"
252  "<Parameter name=\"filtered matrix: reuse eigenvalue\" type=\"bool\" value=\"true\"/>"
253  "<Parameter name=\"filtered matrix: reuse graph\" type=\"bool\" value=\"true\"/>"
254  "<Parameter name=\"emin: iterative method\" type=\"string\" value=\"cg\"/>"
255  "<Parameter name=\"emin: num iterations\" type=\"int\" value=\"2\"/>"
256  "<Parameter name=\"emin: num reuse iterations\" type=\"int\" value=\"1\"/>"
257  "<Parameter name=\"emin: pattern\" type=\"string\" value=\"AkPtent\"/>"
258  "<Parameter name=\"emin: pattern order\" type=\"int\" value=\"1\"/>"
259  "<Parameter name=\"tentative: calculate qr\" type=\"bool\" value=\"true\"/>"
260  "<Parameter name=\"tentative: build coarse coordinates\" type=\"bool\" value=\"true\"/>"
261  "<Parameter name=\"repartition: enable\" type=\"bool\" value=\"false\"/>"
262  "<Parameter name=\"repartition: partitioner\" type=\"string\" value=\"zoltan2\"/>"
263  "<ParameterList name=\"repartition: params\"/>"
264  "<Parameter name=\"repartition: start level\" type=\"int\" value=\"2\"/>"
265  "<Parameter name=\"repartition: node repartition level\" type=\"int\" value=\"-1\"/>"
266  "<Parameter name=\"repartition: node id\" type=\"int\" value=\"-1\"/>"
267  "<Parameter name=\"repartition: min rows per proc\" type=\"int\" value=\"800\"/>"
268  "<Parameter name=\"repartition: target rows per proc\" type=\"int\" value=\"0\"/>"
269  "<Parameter name=\"repartition: min rows per thread\" type=\"int\" value=\"0\"/>"
270  "<Parameter name=\"repartition: target rows per thread\" type=\"int\" value=\"0\"/>"
271  "<Parameter name=\"repartition: max imbalance\" type=\"double\" value=\"1.2\"/>"
272  "<Parameter name=\"repartition: remap parts\" type=\"bool\" value=\"true\"/>"
273  "<Parameter name=\"repartition: remap num values\" type=\"int\" value=\"4\"/>"
274  "<Parameter name=\"repartition: remap accept partition\" type=\"bool\" value=\"true\"/>"
275  "<Parameter name=\"repartition: print partition distribution\" type=\"bool\" value=\"false\"/>"
276  "<Parameter name=\"repartition: rebalance P and R\" type=\"bool\" value=\"false\"/>"
277  "<Parameter name=\"repartition: rebalance Nullspace\" type=\"bool\" value=\"true\"/>"
278  "<Parameter name=\"repartition: use subcommunicators\" type=\"bool\" value=\"true\"/>"
279  "<Parameter name=\"rap: relative diagonal floor\" type=\"Array(double)\" value=\"{}\"/>"
280  "<Parameter name=\"rap: fix zero diagonals\" type=\"bool\" value=\"false\"/>"
281  "<Parameter name=\"rap: fix zero diagonals threshold\" type=\"double\" value=\"0.\"/>"
282  "<Parameter name=\"rap: shift\" type=\"double\" value=\"0.0\"/>"
283  "<Parameter name=\"rap: shift diagonal M\" type=\"bool\" value=\"false\"/>"
284  "<Parameter name=\"rap: shift low storage\" type=\"bool\" value=\"false\"/>"
285  "<Parameter name=\"rap: shift array\" type=\"Array(double)\" value=\"{}\"/>"
286  "<Parameter name=\"rap: cfl array\" type=\"Array(double)\" value=\"{}\"/>"
287  "<Parameter name=\"rap: algorithm\" type=\"string\" value=\"galerkin\"/>"
288  "<ParameterList name=\"matrixmatrix: kernel params\"/>"
289  "<Parameter name=\"matrixmatrix: kernel params:MM_TAFC_OptimizationCoreCount \" type=\"int\" value=\"3000 \"/>"
290  "<Parameter name=\"isMatrixMatrix_TransferAndFillComplete \" type=\"bool\" value=\"false\"/>"
291  "<Parameter name=\"reuse: type\" type=\"string\" value=\"none\"/>"
292  "<Parameter name=\"use external multigrid package\" type=\"string\" value=\"none\"/>"
293  "<ParameterList name=\"amgx:params\"/>"
294  "<Parameter name=\"debug: graph level\" type=\"int\" value=\"-1\"/>"
295  "<Parameter name=\"refmaxwell: mode\" type=\"string\" value=\"additive\"/>"
296  "<Parameter name=\"refmaxwell: disable addon\" type=\"bool\" value=\"true\"/>"
297  "<ParameterList name=\"refmaxwell: 11list\"/>"
298  "<ParameterList name=\"refmaxwell: 22list\"/>"
299  "<Parameter name=\"refmaxwell: use as preconditioner\" type=\"bool\" value=\"false\"/>"
300  "<Parameter name=\"refmaxwell: dump matrices\" type=\"bool\" value=\"false\"/>"
301  "<Parameter name=\"refmaxwell: subsolves on subcommunicators\" type=\"bool\" value=\"false\"/>"
302  "<Parameter name=\"refmaxwell: ratio AH / A22 subcommunicators\" type=\"double\" value=\"1.0\"/>"
303 "</ParameterList>"
304 ;
305  std::map<std::string,std::string> MasterList::DefaultProblemTypeLists_ = DefaultProblemStrings<std::string,std::string>
306 ("Poisson-2D",
307 
308  "<ParameterList name=\"MueLu\">"
309 
310  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
311 
312  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
313 
314  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
315 
316  "</ParameterList>"
317  )
318 ("Poisson-2D-complex",
319 
320  "<ParameterList name=\"MueLu\">"
321 
322  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
323 
324  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
325 
326  "<ParameterList name=\"smoother: params\">"
327 
328  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
329 
330  "</ParameterList>"
331 
332  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
333 
334  "</ParameterList>"
335  )
336 ("Poisson-3D",
337 
338  "<ParameterList name=\"MueLu\">"
339 
340  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
341 
342  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
343 
344  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
345 
346  "</ParameterList>"
347  )
348 ("Poisson-3D-complex",
349 
350  "<ParameterList name=\"MueLu\">"
351 
352  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
353 
354  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
355 
356  "<ParameterList name=\"smoother: params\">"
357 
358  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
359 
360  "</ParameterList>"
361 
362  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
363 
364  "</ParameterList>"
365  )
366 ("Elasticity-2D",
367 
368  "<ParameterList name=\"MueLu\">"
369 
370  "<Parameter name=\"number of equations\" type=\"int\" value=\"2\"/>"
371 
372  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
373 
374  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
375 
376  "</ParameterList>"
377  )
378 ("Elasticity-2D-complex",
379 
380  "<ParameterList name=\"MueLu\">"
381 
382  "<Parameter name=\"number of equations\" type=\"int\" value=\"2\"/>"
383 
384  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
385 
386  "<ParameterList name=\"smoother: params\">"
387 
388  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
389 
390  "</ParameterList>"
391 
392  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
393 
394  "</ParameterList>"
395  )
396 ("Elasticity-3D",
397 
398  "<ParameterList name=\"MueLu\">"
399 
400  "<Parameter name=\"number of equations\" type=\"int\" value=\"3\"/>"
401 
402  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
403 
404  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
405 
406  "</ParameterList>"
407  )
408 ("Elasticity-3D-complex",
409 
410  "<ParameterList name=\"MueLu\">"
411 
412  "<Parameter name=\"number of equations\" type=\"int\" value=\"3\"/>"
413 
414  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
415 
416  "<ParameterList name=\"smoother: params\">"
417 
418  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
419 
420  "</ParameterList>"
421 
422  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
423 
424  "</ParameterList>"
425  )
426 ("MHD",
427 
428  "<ParameterList name=\"MueLu\">"
429 
430  "<Parameter name=\"smoother: type\" type=\"string\" value=\"SCHWARZ\"/>"
431 
432  "<ParameterList name=\"smoother: params\">"
433 
434  "<Parameter name=\"schwarz: overlap level\" type=\"int\" value=\"1\"/>"
435 
436  "<Parameter name=\"schwarz: combine mode\" type=\"string\" value=\"Zero\"/>"
437 
438  "<Parameter name=\"schwarz: use reordering\" type=\"bool\" value=\"false\"/>"
439 
440  "<Parameter name=\"subdomain solver name\" type=\"string\" value=\"RILUK\"/>"
441 
442  "<ParameterList name=\"subdomain solver parameters\">"
443 
444  "<Parameter name=\"fact: iluk level-of-fill\" type=\"int\" value=\"0\"/>"
445 
446  "<Parameter name=\"fact: absolute threshold\" type=\"double\" value=\"0.\"/>"
447 
448  "<Parameter name=\"fact: relative threshold\" type=\"double\" value=\"1.\"/>"
449 
450  "<Parameter name=\"fact: relax value\" type=\"double\" value=\"0.\"/>"
451 
452  "</ParameterList>"
453 
454  "</ParameterList>"
455 
456  "<Parameter name=\"transpose: use implicit\" type=\"bool\" value=\"true\"/>"
457 
458  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"unsmoothed\"/>"
459 
460  "</ParameterList>"
461  )
462 ("ConvectionDiffusion",
463 
464  "<ParameterList name=\"MueLu\">"
465 
466  "<Parameter name=\"problem: symmetric\" type=\"bool\" value=\"false\"/>"
467 
468  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
469 
470  "<ParameterList name=\"smoother: params\">"
471 
472  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Gauss-Seidel\"/>"
473 
474  "</ParameterList>"
475 
476  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"pg\"/>"
477 
478  "<Parameter name=\"sa: use filtered matrix\" type=\"bool\" value=\"true\"/>"
479 
480  "</ParameterList>"
481  )
482 ;
483  std::map<std::string,std::string> MasterList::ML2MueLuLists_ = DefaultProblemStrings<std::string,std::string>
484 
485  ("default values","problem: type")
486 
487  ("ML output","verbosity")
488 
489  ("PDE equations","number of equations")
490 
491  ("max levels","max levels")
492 
493  ("prec type","cycle type")
494 
495  ("coarse grid correction scaling factor","coarse grid correction scaling factor")
496 
497  ("fuse prolongation and update","fuse prolongation and update")
498 
499  ("problem: symmetric","problem: symmetric")
500 
501  ("xml parameter file","xml parameter file")
502 
503  ("parameterlist: syntax","parameterlist: syntax")
504 
505  ("hierarchy label","hierarchy label")
506 
507  ("matvec params","matvec params")
508 
509  ("smoother: pre or post","smoother: pre or post")
510 
511  ("smoother: type","smoother: type")
512 
513  ("smoother: pre type","smoother: pre type")
514 
515  ("smoother: post type","smoother: post type")
516 
517  ("smoother: params","smoother: params")
518 
519  ("smoother: pre params","smoother: pre params")
520 
521  ("smoother: post params","smoother: post params")
522 
523  ("smoother: overlap","smoother: overlap")
524 
525  ("smoother: pre overlap","smoother: pre overlap")
526 
527  ("smoother: post overlap","smoother: post overlap")
528 
529  ("max size","coarse: max size")
530 
531  ("coarse: type","coarse: type")
532 
533  ("coarse: params","coarse: params")
534 
535  ("coarse: overlap","coarse: overlap")
536 
537  ("aggregation: type","aggregation: type")
538 
539  ("aggregation: mode","aggregation: mode")
540 
541  ("aggregation: ordering","aggregation: ordering")
542 
543  ("aggregation: drop scheme","aggregation: drop scheme")
544 
545  ("aggregation: threshold","aggregation: drop tol")
546 
547  ("aggregation: min agg size","aggregation: min agg size")
548 
549  ("aggregation: max agg size","aggregation: max agg size")
550 
551  ("aggregation: brick x size","aggregation: brick x size")
552 
553  ("aggregation: brick y size","aggregation: brick y size")
554 
555  ("aggregation: brick z size","aggregation: brick z size")
556 
557  ("aggregation: max selected neighbors","aggregation: max selected neighbors")
558 
559  ("aggregation: Dirichlet threshold","aggregation: Dirichlet threshold")
560 
561  ("aggregation: deterministic","aggregation: deterministic")
562 
563  ("aggregation: phase 1 algorithm","aggregation: phase 1 algorithm")
564 
565  ("aggregation: enable phase 1","aggregation: enable phase 1")
566 
567  ("aggregation: enable phase 2a","aggregation: enable phase 2a")
568 
569  ("aggregation: enable phase 2b","aggregation: enable phase 2b")
570 
571  ("aggregation: enable phase 3","aggregation: enable phase 3")
572 
573  ("aggregation: error on nodes with no on-rank neighbors","aggregation: error on nodes with no on-rank neighbors")
574 
575  ("aggregation: phase3 avoid singletons","aggregation: phase3 avoid singletons")
576 
577  ("aggregation: allow empty prolongator columns","aggregation: allow empty prolongator columns")
578 
579  ("aggregation: preserve Dirichlet points","aggregation: preserve Dirichlet points")
580 
581  ("aggregation: allow user-specified singletons","aggregation: allow user-specified singletons")
582 
583  ("aggregation: use interface aggregation","aggregation: use interface aggregation")
584 
585  ("aggregation: export visualization data","aggregation: export visualization data")
586 
587  ("aggregation: output filename","aggregation: output filename")
588 
589  ("aggregation: output file: time step","aggregation: output file: time step")
590 
591  ("aggregation: output file: iter","aggregation: output file: iter")
592 
593  ("aggregation: output file: agg style","aggregation: output file: agg style")
594 
595  ("aggregation: output file: fine graph edges","aggregation: output file: fine graph edges")
596 
597  ("aggregation: output file: coarse graph edges","aggregation: output file: coarse graph edges")
598 
599  ("aggregation: output file: build colormap","aggregation: output file: build colormap")
600 
601  ("aggregation: params","aggregation: params")
602 
603  ("strength-of-connection: params","strength-of-connection: params")
604 
605  ("aggregation: mesh layout","aggregation: mesh layout")
606 
607  ("aggregation: output type","aggregation: output type")
608 
609  ("aggregation: coarsening rate","aggregation: coarsening rate")
610 
611  ("aggregation: number of spatial dimensions","aggregation: number of spatial dimensions")
612 
613  ("aggregation: coarsening order","aggregation: coarsening order")
614 
615  ("export data","export data")
616 
617  ("ML print initial list","print initial parameters")
618 
619  ("print unused","print unused parameters")
620 
621  ("transpose: use implicit","transpose: use implicit")
622 
623  ("restriction: scale nullspace","restriction: scale nullspace")
624 
625  ("use kokkos refactor","use kokkos refactor")
626 
627  ("synchronize factory timers","synchronize factory timers")
628 
629  ("rap: triple product","rap: triple product")
630 
631  ("energy minimization: enable","multigrid algorithm")
632 
633  ("toggle: mode","toggle: mode")
634 
635  ("semicoarsen: coarsen rate","semicoarsen: coarsen rate")
636 
637  ("semicoarsen: number of levels","semicoarsen: number of levels")
638 
639  ("linedetection: orientation","linedetection: orientation")
640 
641  ("linedetection: num layers","linedetection: num layers")
642 
643  ("aggregation: damping factor","sa: damping factor")
644 
645  ("sa: use filtered matrix","sa: use filtered matrix")
646 
647  ("sa: calculate eigenvalue estimate","sa: calculate eigenvalue estimate")
648 
649  ("eigen-analysis: iterations","sa: eigenvalue estimate num iterations")
650 
651  ("interp: interpolation order","interp: interpolation order")
652 
653  ("interp: build coarse coordinates","interp: build coarse coordinates")
654 
655  ("transfer: params","transfer: params")
656 
657  ("pcoarsen: element","pcoarsen: element")
658 
659  ("pcoarsen: schedule","pcoarsen: schedule")
660 
661  ("pcoarsen: hi basis","pcoarsen: hi basis")
662 
663  ("pcoarsen: lo basis","pcoarsen: lo basis")
664 
665  ("smoother: neighborhood type","smoother: neighborhood type")
666 
667  ("filtered matrix: use lumping","filtered matrix: use lumping")
668 
669  ("filtered matrix: reuse eigenvalue","filtered matrix: reuse eigenvalue")
670 
671  ("filtered matrix: reuse graph","filtered matrix: reuse graph")
672 
673  ("emin: iterative method","emin: iterative method")
674 
675  ("emin: num iterations","emin: num iterations")
676 
677  ("emin: num reuse iterations","emin: num reuse iterations")
678 
679  ("emin: pattern","emin: pattern")
680 
681  ("emin: pattern order","emin: pattern order")
682 
683  ("tentative: calculate qr","tentative: calculate qr")
684 
685  ("tentative: build coarse coordinates","tentative: build coarse coordinates")
686 
687  ("repartition: enable","repartition: enable")
688 
689  ("repartition: partitioner","repartition: partitioner")
690 
691  ("repartition: params","repartition: params")
692 
693  ("repartition: start level","repartition: start level")
694 
695  ("repartition: node repartition level","repartition: node repartition level")
696 
697  ("repartition: node id","repartition: node id")
698 
699  ("repartition: min per proc","repartition: min rows per proc")
700 
701  ("repartition: target rows per proc","repartition: target rows per proc")
702 
703  ("repartition: min rows per thread","repartition: min rows per thread")
704 
705  ("repartition: target rows per thread","repartition: target rows per thread")
706 
707  ("repartition: max min ratio","repartition: max imbalance")
708 
709  ("repartition: remap parts","repartition: remap parts")
710 
711  ("repartition: remap num values","repartition: remap num values")
712 
713  ("repartition: remap accept partition","repartition: remap accept partition")
714 
715  ("repartition: print partition distribution","repartition: print partition distribution")
716 
717  ("repartition: rebalance P and R","repartition: rebalance P and R")
718 
719  ("repartition: rebalance Nullspace","repartition: rebalance Nullspace")
720 
721  ("repartition: use subcommunicators","repartition: use subcommunicators")
722 
723  ("rap: relative diagonal floor","rap: relative diagonal floor")
724 
725  ("rap: fix zero diagonals","rap: fix zero diagonals")
726 
727  ("rap: fix zero diagonals threshold","rap: fix zero diagonals threshold")
728 
729  ("rap: shift","rap: shift")
730 
731  ("rap: shift diagonal M","rap: shift diagonal M")
732 
733  ("rap: shift low storage","rap: shift low storage")
734 
735  ("rap: shift array","rap: shift array")
736 
737  ("rap: cfl array","rap: cfl array")
738 
739  ("rap: algorithm","rap: algorithm")
740 
741  ("matrixmatrix: kernel params","matrixmatrix: kernel params")
742 
743  ("matrixmatrix: kernel params:MM_TAFC_OptimizationCoreCount ","matrixmatrix: kernel params:MM_TAFC_OptimizationCoreCount ")
744 
745  ("isMatrixMatrix_TransferAndFillComplete ","isMatrixMatrix_TransferAndFillComplete ")
746 
747  ("reuse: type","reuse: type")
748 
749  ("use external multigrid package","use external multigrid package")
750 
751  ("amgx:params","amgx:params")
752 
753  ("debug: graph level","debug: graph level")
754 
755  ("refmaxwell: mode","refmaxwell: mode")
756 
757  ("refmaxwell: disable addon","refmaxwell: disable addon")
758 
759  ("refmaxwell: 11list","refmaxwell: 11list")
760 
761  ("refmaxwell: 22list","refmaxwell: 22list")
762 
763  ("zero starting solution","refmaxwell: use as preconditioner")
764 
765  ("refmaxwell: dump matrices","refmaxwell: dump matrices")
766 
767  ("refmaxwell: subsolves on subcommunicators","refmaxwell: subsolves on subcommunicators")
768 
769  ("refmaxwell: ratio AH / A22 subcommunicators","refmaxwell: ratio AH / A22 subcommunicators")
770  ;
771 
772 }
773 
MueLu::MasterList::ML2MueLuLists_
static std::map< std::string, std::string > ML2MueLuLists_
Map of ML parameter strings to corresponding MueLu parametes.
Definition: MueLu_MasterList.hpp:129
MueLu::MasterList::stringList_
static const std::string stringList_
String equivalent of the masterList_.
Definition: MueLu_MasterList.hpp:121
MueLu::MasterList::problemSpecificList_
static Teuchos::RCP< Teuchos::ParameterList > problemSpecificList_
A ParameterList that holds all valid parameters and their default values for a particular problem typ...
Definition: MueLu_MasterList.hpp:123
MueLu_Exceptions.hpp
MueLu::MasterList::interpretParameterName
static std::string interpretParameterName(const std::string &name, const std::string &value)
Definition: MueLu_MasterList.cpp:75
TEUCHOS_TEST_FOR_EXCEPTION
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Teuchos_XMLParameterListCoreHelpers.hpp
MueLu::MasterList::masterList_
static Teuchos::RCP< Teuchos::ParameterList > masterList_
A ParameterList that holds all valid parameters and their default values.
Definition: MueLu_MasterList.hpp:119
MueLu_MasterList.hpp
MueLu::MasterList::GetProblemSpecificList
static Teuchos::RCP< Teuchos::ParameterList > GetProblemSpecificList(std::string const &problemType)
Return default parameter settings for the specified problem type.
Definition: MueLu_MasterList.cpp:61
MueLu::Exceptions::RuntimeError
Exception throws to report errors in the internal logical of the program.
Definition: MueLu_Exceptions.hpp:70
MueLu::MasterList::List
static Teuchos::RCP< const Teuchos::ParameterList > List()
Return a &quot;master&quot; list of all valid parameters and their default values.
Definition: MueLu_MasterList.cpp:53
MueLu::DefaultProblemStrings
Helper class to initialize DefaultProblemTypeLists_ in class MasterList.
Definition: MueLu_MasterList.hpp:70
MueLu::MasterList::DefaultProblemTypeLists_
static std::map< std::string, std::string > DefaultProblemTypeLists_
Map of string equivalents of the problemSpecificList_. The first entry is the problem type...
Definition: MueLu_MasterList.hpp:127
MueLu::MasterList::problemType_
static std::string problemType_
The problem type associated with the current problem-specific ParameterList.
Definition: MueLu_MasterList.hpp:125
Teuchos::RCP::is_null
bool is_null() const