MueLu  Version of the Day
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 == "problem: symmetric") { ss << "<Parameter name=\"problem: symmetric\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
126  if (name == "hierarchy label") { ss << "<Parameter name=\"hierarchy label\" type=\"string\" value=" << value << "/>"; return ss.str(); }
127  if (name == "aggregation: drop tol") { ss << "<Parameter name=\"aggregation: drop tol\" type=\"double\" value=" << value << "/>"; return ss.str(); }
128  if (name == "print initial parameters") { ss << "<Parameter name=\"print initial parameters\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
129  if (name == "print unused parameters") { ss << "<Parameter name=\"print unused parameters\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
130  if (name == "sa: damping factor") { ss << "<Parameter name=\"sa: damping factor\" type=\"double\" value=" << value << "/>"; return ss.str(); }
131  if (name == "sa: eigenvalue estimate num iterations") { ss << "<Parameter name=\"sa: eigenvalue estimate num iterations\" type=\"int\" value=" << value << "/>"; return ss.str(); }
132  if (name == "pcoarsen: element") { ss << "<Parameter name=\"pcoarsen: element\" type=\"string\" value=" << value << "/>"; return ss.str(); }
133  if (name == "pcoarsen: schedule") { ss << "<Parameter name=\"pcoarsen: schedule\" type=\"string\" value=" << value << "/>"; return ss.str(); }
134  if (name == "pcoarsen: hi basis") { ss << "<Parameter name=\"pcoarsen: hi basis\" type=\"string\" value=" << value << "/>"; return ss.str(); }
135  if (name == "pcoarsen: lo basis") { ss << "<Parameter name=\"pcoarsen: lo basis\" type=\"string\" value=" << value << "/>"; return ss.str(); }
136  if (name == "smoother: neighborhood type") { ss << "<Parameter name=\"smoother: neighborhood type\" type=\"string\" value=" << value << "/>"; return ss.str(); }
137  if (name == "tentative: calculate qr") { ss << "<Parameter name=\"tentative: calculate qr\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
138  if (name == "repartition: enable") { ss << "<Parameter name=\"repartition: enable\" type=\"bool\" value=" << value << "/>"; return ss.str(); }
139  if (name == "repartition: start level") { ss << "<Parameter name=\"repartition: start level\" type=\"int\" value=" << value << "/>"; return ss.str(); }
140  if (name == "repartition: min rows per proc") { ss << "<Parameter name=\"repartition: min rows per proc\" type=\"int\" value=" << value << "/>"; return ss.str(); }
141  if (name == "repartition: max imbalance") { ss << "<Parameter name=\"repartition: max imbalance\" type=\"double\" value=" << value << "/>"; return ss.str(); }
142  if (name == "use external multigrid package") { ss << "<Parameter name=\"use external multigrid package\" type=\"string\" value=" << value << "/>"; return ss.str(); }
143  return "";
144  }
145 
146  Teuchos::RCP<Teuchos::ParameterList> MasterList::masterList_ = Teuchos::null;
147  Teuchos::RCP<Teuchos::ParameterList> MasterList::problemSpecificList_ = Teuchos::null;
148  std::string MasterList::problemType_ = "unknown";
149  const std::string MasterList::stringList_ =
150 "<ParameterList name=\"MueLu\">"
151  "<Parameter name=\"problem: type\" type=\"string\" value=\"unknown\"/>"
152  "<Parameter name=\"verbosity\" type=\"string\" value=\"high\"/>"
153  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
154  "<Parameter name=\"max levels\" type=\"int\" value=\"10\"/>"
155  "<Parameter name=\"cycle type\" type=\"string\" value=\"V\"/>"
156  "<Parameter name=\"coarse grid correction scaling factor\" type=\"double\" value=\"1.0\"/>"
157  "<Parameter name=\"problem: symmetric\" type=\"bool\" value=\"true\"/>"
158  "<Parameter name=\"xml parameter file\" type=\"string\" value=\"\"/>"
159  "<Parameter name=\"parameterlist: syntax\" type=\"string\" value=\"muelu\"/>"
160  "<Parameter name=\"hierarchy label\" type=\"string\" value=\"\"/>"
161  "<Parameter name=\"smoother: pre or post\" type=\"string\" value=\"both\"/>"
162  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
163  "<Parameter name=\"smoother: pre type\" type=\"string\" value=\"RELAXATION\"/>"
164  "<Parameter name=\"smoother: post type\" type=\"string\" value=\"RELAXATION\"/>"
165  "<ParameterList name=\"smoother: params\"/>"
166  "<ParameterList name=\"smoother: pre params\"/>"
167  "<ParameterList name=\"smoother: post params\"/>"
168  "<Parameter name=\"smoother: overlap\" type=\"int\" value=\"0\"/>"
169  "<Parameter name=\"smoother: pre overlap\" type=\"int\" value=\"0\"/>"
170  "<Parameter name=\"smoother: post overlap\" type=\"int\" value=\"0\"/>"
171  "<Parameter name=\"coarse: max size\" type=\"int\" value=\"2000\"/>"
172  "<Parameter name=\"coarse: type\" type=\"string\" value=\"SuperLU\"/>"
173  "<ParameterList name=\"coarse: params\"/>"
174  "<Parameter name=\"coarse: overlap\" type=\"int\" value=\"0\"/>"
175  "<Parameter name=\"aggregation: type\" type=\"string\" value=\"uncoupled\"/>"
176  "<Parameter name=\"aggregation: ordering\" type=\"string\" value=\"natural\"/>"
177  "<Parameter name=\"aggregation: drop scheme\" type=\"string\" value=\"classical\"/>"
178  "<Parameter name=\"aggregation: drop tol\" type=\"double\" value=\"0.0\"/>"
179  "<Parameter name=\"aggregation: min agg size\" type=\"int\" value=\"2\"/>"
180  "<Parameter name=\"aggregation: max agg size\" type=\"int\" value=\"-1\"/>"
181  "<Parameter name=\"aggregation: brick x size\" type=\"int\" value=\"2\"/>"
182  "<Parameter name=\"aggregation: brick y size\" type=\"int\" value=\"2\"/>"
183  "<Parameter name=\"aggregation: brick z size\" type=\"int\" value=\"2\"/>"
184  "<Parameter name=\"aggregation: max selected neighbors\" type=\"int\" value=\"0\"/>"
185  "<Parameter name=\"aggregation: Dirichlet threshold\" type=\"double\" value=\"0.0\"/>"
186  "<Parameter name=\"aggregation: phase 1 algorithm\" type=\"string\" value=\"Serial\"/>"
187  "<Parameter name=\"aggregation: enable phase 1\" type=\"bool\" value=\"true\"/>"
188  "<Parameter name=\"aggregation: enable phase 2a\" type=\"bool\" value=\"true\"/>"
189  "<Parameter name=\"aggregation: enable phase 2b\" type=\"bool\" value=\"true\"/>"
190  "<Parameter name=\"aggregation: enable phase 3\" type=\"bool\" value=\"true\"/>"
191  "<Parameter name=\"aggregation: error on nodes with no on-rank neighbors\" type=\"bool\" value=\"false\"/>"
192  "<Parameter name=\"aggregation: allow empty prolongator columns\" type=\"bool\" value=\"false\"/>"
193  "<Parameter name=\"aggregation: preserve Dirichlet points\" type=\"bool\" value=\"false\"/>"
194  "<Parameter name=\"aggregation: allow user-specified singletons\" type=\"bool\" value=\"false\"/>"
195  "<Parameter name=\"aggregation: use interface aggregation\" type=\"bool\" value=\"false\"/>"
196  "<Parameter name=\"aggregation: export visualization data\" type=\"bool\" value=\"false\"/>"
197  "<Parameter name=\"aggregation: output filename\" type=\"string\" value=\"\"/>"
198  "<Parameter name=\"aggregation: output file: time step\" type=\"int\" value=\"0\"/>"
199  "<Parameter name=\"aggregation: output file: iter\" type=\"int\" value=\"0\"/>"
200  "<Parameter name=\"aggregation: output file: agg style\" type=\"string\" value=\"Point Cloud\"/>"
201  "<Parameter name=\"aggregation: output file: fine graph edges\" type=\"bool\" value=\"false\"/>"
202  "<Parameter name=\"aggregation: output file: coarse graph edges\" type=\"bool\" value=\"false\"/>"
203  "<Parameter name=\"aggregation: output file: build colormap\" type=\"bool\" value=\"false\"/>"
204  "<ParameterList name=\"aggregation: params\"/>"
205  "<ParameterList name=\"strength-of-connection: params\"/>"
206  "<ParameterList name=\"export data\"/>"
207  "<Parameter name=\"print initial parameters\" type=\"bool\" value=\"true\"/>"
208  "<Parameter name=\"print unused parameters\" type=\"bool\" value=\"true\"/>"
209  "<Parameter name=\"transpose: use implicit\" type=\"bool\" value=\"false\"/>"
210  "<Parameter name=\"use kokkos refactor\" type=\"bool\" value=\"false\"/>"
211  "<Parameter name=\"synchronize factory timers\" type=\"bool\" value=\"false\"/>"
212  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
213  "<Parameter name=\"toggle: mode\" type=\"string\" value=\"semicoarsen\"/>"
214  "<Parameter name=\"semicoarsen: coarsen rate\" type=\"int\" value=\"3\"/>"
215  "<Parameter name=\"semicoarsen: number of levels\" type=\"int\" value=\"3\"/>"
216  "<Parameter name=\"linedetection: orientation\" type=\"string\" value=\"vertical\"/>"
217  "<Parameter name=\"linedetection: num layers\" type=\"int\" value=\"-1\"/>"
218  "<Parameter name=\"sa: damping factor\" type=\"double\" value=\"1.33\"/>"
219  "<Parameter name=\"sa: use filtered matrix\" type=\"bool\" value=\"true\"/>"
220  "<Parameter name=\"sa: calculate eigenvalue estimate\" type=\"bool\" value=\"false\"/>"
221  "<Parameter name=\"sa: eigenvalue estimate num iterations\" type=\"int\" value=\"10\"/>"
222  "<Parameter name=\"gmg: interpolation order\" type=\"int\" value=\"1\"/>"
223  "<Parameter name=\"gmg: build coarse coordinates\" type=\"bool\" value=\"true\"/>"
224  "<ParameterList name=\"transfer: params\"/>"
225  "<Parameter name=\"pcoarsen: element\" type=\"string\" value=\"\"/>"
226  "<Parameter name=\"pcoarsen: schedule\" type=\"string\" value=\"\"/>"
227  "<Parameter name=\"pcoarsen: hi basis\" type=\"string\" value=\"\"/>"
228  "<Parameter name=\"pcoarsen: lo basis\" type=\"string\" value=\"\"/>"
229  "<Parameter name=\"smoother: neighborhood type\" type=\"string\" value=\"\"/>"
230  "<Parameter name=\"filtered matrix: use lumping\" type=\"bool\" value=\"true\"/>"
231  "<Parameter name=\"filtered matrix: reuse eigenvalue\" type=\"bool\" value=\"true\"/>"
232  "<Parameter name=\"filtered matrix: reuse graph\" type=\"bool\" value=\"true\"/>"
233  "<Parameter name=\"emin: iterative method\" type=\"string\" value=\"cg\"/>"
234  "<Parameter name=\"emin: num iterations\" type=\"int\" value=\"2\"/>"
235  "<Parameter name=\"emin: num reuse iterations\" type=\"int\" value=\"1\"/>"
236  "<Parameter name=\"emin: pattern\" type=\"string\" value=\"AkPtent\"/>"
237  "<Parameter name=\"emin: pattern order\" type=\"int\" value=\"1\"/>"
238  "<Parameter name=\"tentative: calculate qr\" type=\"bool\" value=\"true\"/>"
239  "<Parameter name=\"tentative: build coarse coordinates\" type=\"bool\" value=\"true\"/>"
240  "<Parameter name=\"repartition: enable\" type=\"bool\" value=\"false\"/>"
241  "<Parameter name=\"repartition: partitioner\" type=\"string\" value=\"zoltan2\"/>"
242  "<ParameterList name=\"repartition: params\"/>"
243  "<Parameter name=\"repartition: start level\" type=\"int\" value=\"2\"/>"
244  "<Parameter name=\"repartition: min rows per proc\" type=\"int\" value=\"800\"/>"
245  "<Parameter name=\"repartition: target rows per proc\" type=\"int\" value=\"0\"/>"
246  "<Parameter name=\"repartition: max imbalance\" type=\"double\" value=\"1.2\"/>"
247  "<Parameter name=\"repartition: remap parts\" type=\"bool\" value=\"true\"/>"
248  "<Parameter name=\"repartition: remap num values\" type=\"int\" value=\"4\"/>"
249  "<Parameter name=\"repartition: print partition distribution\" type=\"bool\" value=\"false\"/>"
250  "<Parameter name=\"repartition: rebalance P and R\" type=\"bool\" value=\"false\"/>"
251  "<Parameter name=\"repartition: use subcommunicators\" type=\"bool\" value=\"true\"/>"
252  "<Parameter name=\"rap: fix zero diagonals\" type=\"bool\" value=\"false\"/>"
253  "<Parameter name=\"rap: shift\" type=\"double\" value=\"0.0\"/>"
254  "<Parameter name=\"rap: algorithm\" type=\"string\" value=\"galerkin\"/>"
255  "<Parameter name=\"rap: triple product\" type=\"bool\" value=\"false\"/>"
256  "<ParameterList name=\"matrixmatrix: kernel params\"/>"
257  "<Parameter name=\"reuse: type\" type=\"string\" value=\"none\"/>"
258  "<Parameter name=\"use external multigrid package\" type=\"string\" value=\"none\"/>"
259  "<ParameterList name=\"amgx:params\"/>"
260  "<Parameter name=\"debug: graph level\" type=\"int\" value=\"-1\"/>"
261 "</ParameterList>"
262 ;
263  std::map<std::string,std::string> MasterList::DefaultProblemTypeLists_ = DefaultProblemStrings<std::string,std::string>
264 ("Poisson-2D",
265 
266  "<ParameterList name=\"MueLu\">"
267 
268  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
269 
270  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
271 
272  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
273 
274  "</ParameterList>"
275  )
276 ("Poisson-2D-complex",
277 
278  "<ParameterList name=\"MueLu\">"
279 
280  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
281 
282  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
283 
284  "<ParameterList name=\"smoother: params\">"
285 
286  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
287 
288  "</ParameterList>"
289 
290  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
291 
292  "</ParameterList>"
293  )
294 ("Poisson-3D",
295 
296  "<ParameterList name=\"MueLu\">"
297 
298  "<Parameter name=\"number of equations\" type=\"int\" value=\"1\"/>"
299 
300  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
301 
302  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
303 
304  "</ParameterList>"
305  )
306 ("Poisson-3D-complex",
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=\"RELAXATION\"/>"
313 
314  "<ParameterList name=\"smoother: params\">"
315 
316  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
317 
318  "</ParameterList>"
319 
320  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
321 
322  "</ParameterList>"
323  )
324 ("Elasticity-2D",
325 
326  "<ParameterList name=\"MueLu\">"
327 
328  "<Parameter name=\"number of equations\" type=\"int\" value=\"2\"/>"
329 
330  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
331 
332  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
333 
334  "</ParameterList>"
335  )
336 ("Elasticity-2D-complex",
337 
338  "<ParameterList name=\"MueLu\">"
339 
340  "<Parameter name=\"number of equations\" type=\"int\" value=\"2\"/>"
341 
342  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
343 
344  "<ParameterList name=\"smoother: params\">"
345 
346  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
347 
348  "</ParameterList>"
349 
350  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
351 
352  "</ParameterList>"
353  )
354 ("Elasticity-3D",
355 
356  "<ParameterList name=\"MueLu\">"
357 
358  "<Parameter name=\"number of equations\" type=\"int\" value=\"3\"/>"
359 
360  "<Parameter name=\"smoother: type\" type=\"string\" value=\"CHEBYSHEV\"/>"
361 
362  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
363 
364  "</ParameterList>"
365  )
366 ("Elasticity-3D-complex",
367 
368  "<ParameterList name=\"MueLu\">"
369 
370  "<Parameter name=\"number of equations\" type=\"int\" value=\"3\"/>"
371 
372  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
373 
374  "<ParameterList name=\"smoother: params\">"
375 
376  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
377 
378  "</ParameterList>"
379 
380  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"sa\"/>"
381 
382  "</ParameterList>"
383  )
384 ("MHD",
385 
386  "<ParameterList name=\"MueLu\">"
387 
388  "<Parameter name=\"smoother: type\" type=\"string\" value=\"SCHWARZ\"/>"
389 
390  "<ParameterList name=\"smoother: params\">"
391 
392  "<Parameter name=\"schwarz: overlap level\" type=\"int\" value=\"1\"/>"
393 
394  "<Parameter name=\"schwarz: combine mode\" type=\"string\" value=\"Zero\"/>"
395 
396  "<Parameter name=\"schwarz: use reordering\" type=\"bool\" value=\"false\"/>"
397 
398  "<Parameter name=\"subdomain solver name\" type=\"string\" value=\"RILUK\"/>"
399 
400  "<ParameterList name=\"subdomain solver parameters\">"
401 
402  "<Parameter name=\"fact: iluk level-of-fill\" type=\"int\" value=\"0\"/>"
403 
404  "<Parameter name=\"fact: absolute threshold\" type=\"double\" value=\"0.\"/>"
405 
406  "<Parameter name=\"fact: relative threshold\" type=\"double\" value=\"1.\"/>"
407 
408  "<Parameter name=\"fact: relax value\" type=\"double\" value=\"0.\"/>"
409 
410  "</ParameterList>"
411 
412  "</ParameterList>"
413 
414  "<Parameter name=\"transpose: use implicit\" type=\"bool\" value=\"true\"/>"
415 
416  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"unsmoothed\"/>"
417 
418  "</ParameterList>"
419  )
420 ("ConvectionDiffusion",
421 
422  "<ParameterList name=\"MueLu\">"
423 
424  "<Parameter name=\"problem: symmetric\" type=\"bool\" value=\"false\"/>"
425 
426  "<Parameter name=\"smoother: type\" type=\"string\" value=\"RELAXATION\"/>"
427 
428  "<ParameterList name=\"smoother: params\">"
429 
430  "<Parameter name=\"relaxation: type\" type=\"string\" value=\"Gauss-Seidel\"/>"
431 
432  "</ParameterList>"
433 
434  "<Parameter name=\"multigrid algorithm\" type=\"string\" value=\"pg\"/>"
435 
436  "<Parameter name=\"sa: use filtered matrix\" type=\"bool\" value=\"true\"/>"
437 
438  "</ParameterList>"
439  )
440 ;
441  std::map<std::string,std::string> MasterList::ML2MueLuLists_ = DefaultProblemStrings<std::string,std::string>
442 
443  ("default values","problem: type")
444 
445  ("ML output","verbosity")
446 
447  ("PDE equations","number of equations")
448 
449  ("max levels","max levels")
450 
451  ("prec type","cycle type")
452 
453  ("coarse grid correction scaling factor","coarse grid correction scaling factor")
454 
455  ("problem: symmetric","problem: symmetric")
456 
457  ("xml parameter file","xml parameter file")
458 
459  ("parameterlist: syntax","parameterlist: syntax")
460 
461  ("hierarchy label","hierarchy label")
462 
463  ("smoother: pre or post","smoother: pre or post")
464 
465  ("smoother: type","smoother: type")
466 
467  ("smoother: pre type","smoother: pre type")
468 
469  ("smoother: post type","smoother: post type")
470 
471  ("smoother: params","smoother: params")
472 
473  ("smoother: pre params","smoother: pre params")
474 
475  ("smoother: post params","smoother: post params")
476 
477  ("smoother: overlap","smoother: overlap")
478 
479  ("smoother: pre overlap","smoother: pre overlap")
480 
481  ("smoother: post overlap","smoother: post overlap")
482 
483  ("max size","coarse: max size")
484 
485  ("coarse: type","coarse: type")
486 
487  ("coarse: params","coarse: params")
488 
489  ("coarse: overlap","coarse: overlap")
490 
491  ("aggregation: type","aggregation: type")
492 
493  ("aggregation: ordering","aggregation: ordering")
494 
495  ("aggregation: drop scheme","aggregation: drop scheme")
496 
497  ("aggregation: threshold","aggregation: drop tol")
498 
499  ("aggregation: min agg size","aggregation: min agg size")
500 
501  ("aggregation: max agg size","aggregation: max agg size")
502 
503  ("aggregation: brick x size","aggregation: brick x size")
504 
505  ("aggregation: brick y size","aggregation: brick y size")
506 
507  ("aggregation: brick z size","aggregation: brick z size")
508 
509  ("aggregation: max selected neighbors","aggregation: max selected neighbors")
510 
511  ("aggregation: Dirichlet threshold","aggregation: Dirichlet threshold")
512 
513  ("aggregation: phase 1 algorithm","aggregation: phase 1 algorithm")
514 
515  ("aggregation: enable phase 1","aggregation: enable phase 1")
516 
517  ("aggregation: enable phase 2a","aggregation: enable phase 2a")
518 
519  ("aggregation: enable phase 2b","aggregation: enable phase 2b")
520 
521  ("aggregation: enable phase 3","aggregation: enable phase 3")
522 
523  ("aggregation: error on nodes with no on-rank neighbors","aggregation: error on nodes with no on-rank neighbors")
524 
525  ("aggregation: allow empty prolongator columns","aggregation: allow empty prolongator columns")
526 
527  ("aggregation: preserve Dirichlet points","aggregation: preserve Dirichlet points")
528 
529  ("aggregation: allow user-specified singletons","aggregation: allow user-specified singletons")
530 
531  ("aggregation: use interface aggregation","aggregation: use interface aggregation")
532 
533  ("aggregation: export visualization data","aggregation: export visualization data")
534 
535  ("aggregation: output filename","aggregation: output filename")
536 
537  ("aggregation: output file: time step","aggregation: output file: time step")
538 
539  ("aggregation: output file: iter","aggregation: output file: iter")
540 
541  ("aggregation: output file: agg style","aggregation: output file: agg style")
542 
543  ("aggregation: output file: fine graph edges","aggregation: output file: fine graph edges")
544 
545  ("aggregation: output file: coarse graph edges","aggregation: output file: coarse graph edges")
546 
547  ("aggregation: output file: build colormap","aggregation: output file: build colormap")
548 
549  ("aggregation: params","aggregation: params")
550 
551  ("strength-of-connection: params","strength-of-connection: params")
552 
553  ("export data","export data")
554 
555  ("ML print initial list","print initial parameters")
556 
557  ("print unused","print unused parameters")
558 
559  ("transpose: use implicit","transpose: use implicit")
560 
561  ("use kokkos refactor","use kokkos refactor")
562 
563  ("synchronize factory timers","synchronize factory timers")
564 
565  ("energy minimization: enable","multigrid algorithm")
566 
567  ("toggle: mode","toggle: mode")
568 
569  ("semicoarsen: coarsen rate","semicoarsen: coarsen rate")
570 
571  ("semicoarsen: number of levels","semicoarsen: number of levels")
572 
573  ("linedetection: orientation","linedetection: orientation")
574 
575  ("linedetection: num layers","linedetection: num layers")
576 
577  ("aggregation: damping factor","sa: damping factor")
578 
579  ("sa: use filtered matrix","sa: use filtered matrix")
580 
581  ("sa: calculate eigenvalue estimate","sa: calculate eigenvalue estimate")
582 
583  ("eigen-analysis: iterations","sa: eigenvalue estimate num iterations")
584 
585  ("gmg: interpolation order","gmg: interpolation order")
586 
587  ("gmg: build coarse coordinates","gmg: build coarse coordinates")
588 
589  ("transfer: params","transfer: params")
590 
591  ("pcoarsen: element","pcoarsen: element")
592 
593  ("pcoarsen: schedule","pcoarsen: schedule")
594 
595  ("pcoarsen: hi basis","pcoarsen: hi basis")
596 
597  ("pcoarsen: lo basis","pcoarsen: lo basis")
598 
599  ("smoother: neighborhood type","smoother: neighborhood type")
600 
601  ("filtered matrix: use lumping","filtered matrix: use lumping")
602 
603  ("filtered matrix: reuse eigenvalue","filtered matrix: reuse eigenvalue")
604 
605  ("filtered matrix: reuse graph","filtered matrix: reuse graph")
606 
607  ("emin: iterative method","emin: iterative method")
608 
609  ("emin: num iterations","emin: num iterations")
610 
611  ("emin: num reuse iterations","emin: num reuse iterations")
612 
613  ("emin: pattern","emin: pattern")
614 
615  ("emin: pattern order","emin: pattern order")
616 
617  ("tentative: calculate qr","tentative: calculate qr")
618 
619  ("tentative: build coarse coordinates","tentative: build coarse coordinates")
620 
621  ("repartition: enable","repartition: enable")
622 
623  ("repartition: partitioner","repartition: partitioner")
624 
625  ("repartition: params","repartition: params")
626 
627  ("repartition: start level","repartition: start level")
628 
629  ("repartition: min per proc","repartition: min rows per proc")
630 
631  ("repartition: target rows per proc","repartition: target rows per proc")
632 
633  ("repartition: max min ratio","repartition: max imbalance")
634 
635  ("repartition: remap parts","repartition: remap parts")
636 
637  ("repartition: remap num values","repartition: remap num values")
638 
639  ("repartition: print partition distribution","repartition: print partition distribution")
640 
641  ("repartition: rebalance P and R","repartition: rebalance P and R")
642 
643  ("repartition: use subcommunicators","repartition: use subcommunicators")
644 
645  ("rap: fix zero diagonals","rap: fix zero diagonals")
646 
647  ("rap: shift","rap: shift")
648 
649  ("rap: algorithm","rap: algorithm")
650 
651  ("rap: triple product","rap: triple product")
652 
653  ("matrixmatrix: kernel params","matrixmatrix: kernel params")
654 
655  ("reuse: type","reuse: type")
656 
657  ("use external multigrid package","use external multigrid package")
658 
659  ("amgx:params","amgx:params")
660 
661  ("debug: graph level","debug: graph level")
662  ;
663 
664 }
665 
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::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::MasterList::interpretParameterName
static std::string interpretParameterName(const std::string &name, const std::string &value)
Definition: MueLu_MasterList.cpp:75
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
Namespace for MueLu classes and methods.
Definition: MueLu_BrickAggregationFactory_decl.hpp:76
MueLu_Exceptions.hpp
MueLu::Exceptions::RuntimeError
Exception throws to report errors in the internal logical of the program.
Definition: MueLu_Exceptions.hpp:70
MueLu::MasterList::problemType_
static std::string problemType_
The problem type associated with the current problem-specific ParameterList.
Definition: MueLu_MasterList.hpp:125
MueLu::DefaultProblemStrings
Helper class to initialize DefaultProblemTypeLists_ in class MasterList.
Definition: MueLu_MasterList.hpp:70
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_MasterList.hpp
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::stringList_
static const std::string stringList_
String equivalent of the masterList_.
Definition: MueLu_MasterList.hpp:121
MueLu::MasterList::List
static Teuchos::RCP< const Teuchos::ParameterList > List()
Return a "master" list of all valid parameters and their default values.
Definition: MueLu_MasterList.cpp:53