1 // @HEADER 2 // *********************************************************************** 3 // 4 // Teuchos: Common Tools Package 5 // Copyright (2004) Sandia Corporation 6 // 7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive 8 // license for use of this work by or on behalf of the U.S. Government. 9 // 10 // Redistribution and use in source and binary forms, with or without 11 // modification, are permitted provided that the following conditions are 12 // met: 13 // 14 // 1. Redistributions of source code must retain the above copyright 15 // notice, this list of conditions and the following disclaimer. 16 // 17 // 2. Redistributions in binary form must reproduce the above copyright 18 // notice, this list of conditions and the following disclaimer in the 19 // documentation and/or other materials provided with the distribution. 20 // 21 // 3. Neither the name of the Corporation nor the names of the 22 // contributors may be used to endorse or promote products derived from 23 // this software without specific prior written permission. 24 // 25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY 26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE 29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 36 // 37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 38 // 39 // *********************************************************************** 40 // @HEADER 41 42 #ifndef TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP 43 #define TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP 44 45 46 /*! \file Teuchos_XMLParameterListHelpers.hpp \brief Additional ParameterList 47 XML helper functions including parallel support. 48 */ 49 50 51 #include "Teuchos_XMLParameterListCoreHelpers.hpp" 52 #include "Teuchos_Comm.hpp" 53 54 55 namespace Teuchos { 56 57 58 /** \brief On processor rank = 0, reads XML parameters from a file 59 * and broadcasts them to all other processors. Then updates the 60 * given parameter list with these values. 61 * 62 * \param xmlFileName [in] The file name containing XML parameter list 63 * specification. 64 * 65 * \param paramList [in/out] On input, <tt>*paramList</tt> may be empty or 66 * contain some parameters and sublists. On output, parameters and sublist 67 * from the file <tt>xmlFileName</tt> will be set or override (or not) those in 68 * <tt>*paramList</tt> depending on the <tt>overwrite</tt> parameter. 69 * 70 * \param comm [in] A Comm object used to broadcast the xml. 71 * 72 * \param overwrite [in] If true, parameters and sublists in the <tt>xmlStr</tt> 73 * will override those in <tt>paramList</tt>. If false, any value set in 74 * <tt>paramList</tt> will be kept, only values not set will be updated. 75 * 76 * \relates ParameterList 77 */ 78 TEUCHOSCOMM_LIB_DLL_EXPORT 79 void updateParametersFromXmlFileAndBroadcast( 80 const std::string &xmlFileName, 81 const Ptr<ParameterList> ¶mList, 82 const Comm<int> &comm, 83 bool overwrite = true 84 ); 85 86 87 } // namespace Teuchos 88 89 90 #endif // TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP 91