opm-core/opm/core/utility/parameters/ParameterXML.hpp
Markus Blatt 52b40c9477 Allow to prevent ParameterGroup from printing to std::cout.
This commit adds a verbose flag to the constructor of
ParameterGroup to allow for deactivating any
output to std:cout. This is handy for parallel runs where we only
want to print statistics on one process.
2015-05-08 11:13:30 +02:00

55 lines
1.7 KiB
C++

//===========================================================================
//
// File: ParameterXML.hpp
//
// Created: Tue Jun 2 18:55:59 2009
//
// Author(s): Bård Skaflestad <bard.skaflestad@sintef.no>
// Atgeirr F Rasmussen <atgeirr@sintef.no>
//
// $Date$
//
// $Revision$
//
//===========================================================================
/*
Copyright 2009, 2010 SINTEF ICT, Applied Mathematics.
Copyright 2009, 2010 Statoil ASA.
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPM_PARAMETERXML_HEADER
#define OPM_PARAMETERXML_HEADER
#include <opm/core/utility/parameters/ParameterGroup.hpp>
namespace Opm {
namespace parameter {
/// \brief This function fills a ParameterGroup with a XML file.
///
/// NOTE: The function throws if there is an error during reading
/// of the XML file.
///
/// \retval pg is the ParameterGroup to be filled.
/// \param filename is the name of an XML file.
void fill_xml(ParameterGroup& pg, const std::string filename, const bool enable_output);
} // namespace parameter
} // namespace Opm
#endif // OPM_PARAMETERXML_HEADER