docs/teuchos/Teuchos__YamlParameterListHelpers_8hpp_source.html

// @HEADER

// *****************************************************************************

//                    Teuchos: Common Tools Package

//

// Copyright 2004 NTESS and the Teuchos contributors.

// SPDX-License-Identifier: BSD-3-Clause

// *****************************************************************************

// @HEADER


#ifndef TEUCHOS_YAML_PARAMETER_LIST_HELPERS_HPP

#define TEUCHOS_YAML_PARAMETER_LIST_HELPERS_HPP


#include "Teuchos_YamlParameterListCoreHelpers.hpp"

#include "Teuchos_Comm.hpp"


namespace Teuchos {


TEUCHOSCOMM_LIB_DLL_EXPORT

void updateParametersFromYamlFileAndBroadcast(

  const std::string &yamlFileName,

  const Teuchos::Ptr<Teuchos::ParameterList> &paramList,

  const Teuchos::Comm<int> &comm,

  bool overwrite = true);


} // namespace Teuchos


#endif // TEUCHOS_Yaml_PARAMETER_LIST_HELPERS_HPP

Teuchos_YamlParameterListCoreHelpers.hpp
Simple helper functions that make it easy to read and write Yaml to and from a parameterlist.

Teuchos::ParameterList::updateParametersFromYamlFileAndBroadcast
TEUCHOSCOMM_LIB_DLL_EXPORT void updateParametersFromYamlFileAndBroadcast(const std::string &yamlFileName, const Teuchos::Ptr< Teuchos::ParameterList > &paramList, const Teuchos::Comm< int > &comm, bool overwrite=true)
On processor rank = 0, reads Yaml parameters from a file and broadcasts them to all other processors....

Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition Teuchos_RCPDecl.hpp:397

Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...