MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_ParameterListUtils.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
47#ifndef MUELU_PARAMETERLISTUTILS_HPP
48#define MUELU_PARAMETERLISTUTILS_HPP
49
50#include <string>
51#include <sstream>
52
53#include <Teuchos_ParameterList.hpp>
54#include <Teuchos_RCPDecl.hpp>
55#include "MueLu_ConfigDefs.hpp"
56
57namespace MueLu {
58
59 /* See also: ML_Epetra::UpdateList */
60 void MergeParameterList(const Teuchos::ParameterList &source, Teuchos::ParameterList &dest, bool overWrite);
61
62 void CreateSublists(const Teuchos::ParameterList &List, Teuchos::ParameterList &newList);
63
64 // Usage: GetMLSubList(paramList, "smoother", 2);
65 const Teuchos::ParameterList & GetMLSubList(const Teuchos::ParameterList & paramList, const std::string & type, int levelID);
66
67 // Extract all the parameters that begin with "str:" (but skip sublist)
68 Teuchos::RCP<Teuchos::ParameterList> ExtractSetOfParameters(const Teuchos::ParameterList & paramList, const std::string & str);
69
75 void replaceAll(std::string& str, const std::string& from, const std::string& to);
76
78 template<typename Type>
79 bool replacePlaceholder(std::string& str, const std::string& placeholder, Type data) {
80 std::stringstream s;
81 s << data;
82 replaceAll(str, placeholder, s.str());
83 return true;
84 }
85
86 template<typename Type>
87 bool actionInterpretParameter(Teuchos::ParameterList& mlParams, const std::string& paramName, std::string& str) {
88
89 //MUELU_READ_PARAM(mlParams, paramName, int, 0, data);
90
91 Type varName; // = defaultValue; // extract from master list
92 if (mlParams.isParameter(paramName)) varName = mlParams.get<Type>(paramName);
93
94 std::stringstream placeholder;
95 placeholder << "$" << paramName << "$";
96
97 return MueLu::replacePlaceholder<Type>(str, placeholder.str(), varName);
98 }
99
100} // namespace MueLu
101
102#endif // MUELU_PARAMETERLISTUTILS_HPP
Namespace for MueLu classes and methods.
Teuchos::RCP< Teuchos::ParameterList > ExtractSetOfParameters(const Teuchos::ParameterList &paramList, const std::string &str)
void CreateSublists(const ParameterList &List, ParameterList &newList)
void replaceAll(std::string &str, const std::string &from, const std::string &to)
bool actionInterpretParameter(Teuchos::ParameterList &mlParams, const std::string &paramName, std::string &str)
bool replacePlaceholder(std::string &str, const std::string &placeholder, Type data)
templated version to replace placeholder by data in "str"
void MergeParameterList(const Teuchos::ParameterList &source, Teuchos::ParameterList &dest, bool overWrite)
: merge two parameter lists
const Teuchos::ParameterList & GetMLSubList(const Teuchos::ParameterList &paramList, const std::string &type, int levelID)