Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_YamlParameterListHelpers.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Teuchos: Common Tools Package
4 //
5 // Copyright 2004 NTESS and the Teuchos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef TEUCHOS_YAML_PARAMETER_LIST_HELPERS_HPP
11 #define TEUCHOS_YAML_PARAMETER_LIST_HELPERS_HPP
12 
13 
20 #include "Teuchos_Comm.hpp"
21 
22 
23 namespace Teuchos {
24 
25 
47 void updateParametersFromYamlFileAndBroadcast(
48  const std::string &yamlFileName,
49  const Teuchos::Ptr<Teuchos::ParameterList> &paramList,
50  const Teuchos::Comm<int> &comm,
51  bool overwrite = true);
52 
53 } // namespace Teuchos
54 
55 
56 #endif // TEUCHOS_Yaml_PARAMETER_LIST_HELPERS_HPP
#define TEUCHOSCOMM_LIB_DLL_EXPORT
Simple helper functions that make it easy to read and write Yaml to and from a parameterlist.
Simple wrapper class for raw pointers to single objects where no persisting relationship exists...