Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
ParameterList_yaml_Parallel.cpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Teuchos
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 
51 #include <Teuchos_ScalarTraits.hpp>
53 #include <Teuchos_Exceptions.hpp>
55 #include <Teuchos_Exceptions.hpp>
56 #include <Teuchos_RCP.hpp>
57 #include <Teuchos_DefaultComm.hpp>
58 
59 using Teuchos::RCP;
60 using Teuchos::rcp;
63 
64 namespace TeuchosTests
65 {
66  TEUCHOS_UNIT_TEST(YAML, MPIBroadcast)
67  {
68  //load Match1.xml and Match1.yaml on proc 0, broadcast them, and make sure it matches on all procs
69  //note: the following code is run on all procs
70  RCP<ParameterList> xmlList = rcp(new ParameterList);
71  RCP<ParameterList> yamlList = rcp(new ParameterList);
72 
74  const std::string n1("Match1.xml");
75  Teuchos::updateParametersFromXmlFileAndBroadcast(n1, xmlList.ptr(), *comm, true);
76  const std::string n2("Match1.yaml");
77  Teuchos::updateParametersFromYamlFileAndBroadcast(n2, yamlList.ptr(), *comm, true);
78  TEST_EQUALITY(Teuchos::haveSameValuesUnordered(*xmlList, *yamlList), true);
79  }
80  TEUCHOS_UNIT_TEST(YAML, ConvertFromXML)
81  {
82  using std::string;
83 
85 
86  //This list can contain any valid XML param lists in the unit_tests/yaml/
87  std::vector<string> xmlFiles = {"Match1.xml", "Match2.xml", "Match3.xml", "Match4.xml", "input_restingHydrostatic_RK4.xml", "plasma_oscillation_rtc.xml"};
88  for(size_t i = 0; i < xmlFiles.size(); i++)
89  {
90  std::string xmlFile = xmlFiles[i];
91  std::string yamlFile = std::string("Proc") + std::to_string(comm->getRank()) + '-' + xmlFiles[i];
92  yamlFile = yamlFile.substr(0, yamlFile.length() - 4) + ".yaml";
93  Teuchos::convertXmlToYaml(xmlFile, yamlFile);
94  RCP<ParameterList> xmlList = Teuchos::getParametersFromXmlFile(xmlFile);
96  TEST_EQUALITY(Teuchos::haveSameValuesUnordered(*xmlList, *yamlList, true), true);
97  }
98  }
99 
100 } //namespace TeuchosTests
Macros for defining unit tests.
#define TEST_EQUALITY(v1, v2)
Assert the equality of v1 and v2.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
Templated Parameter List class.
Unit testing support.
Return a default global communicator appropriate for the build.
Additional ParameterList XML helper functions including parallel support.
A list of parameters of arbitrary type.
TEUCHOS_UNIT_TEST(YAML, XmlEquivalence)
Defines basic traits for the scalar field type.
Smart reference counting pointer class for automatic garbage collection.
std::string convertXmlToYaml(const std::string &xmlFileName)
Teuchos::RCP< Teuchos::ParameterList > getParametersFromYamlFile(const std::string &yamlFileName)
Reference-counted pointer class and non-member templated function implementations.
Ptr< T > ptr() const
Get a safer wrapper raw C++ pointer to the underlying object.
bool haveSameValuesUnordered(const Teuchos::ParameterList &lhs, const Teuchos::ParameterList &rhs, bool verbose)