parameters.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_PARAMETERS_HH
#define DUMUX_PARAMETERS_HH
 
#include <iostream>
#include <list>
#include <sstream>
#include <unordered_map>
#include <fstream>
#include <functional>
 
#include <dune/common/parametertree.hh>
 
#include <dumux/common/defaultusagemessage.hh>
#include <dumux/common/loggingparametertree.hh>
 
namespace Dumux {
 
class Parameters {
 
    using DefaultParams = std::function<void (Dune::ParameterTree&)>;
    using Usage = std::function<void (const char *, const std::string &)>;
 
public:
 
    static void init(int argc, char **argv, const Usage& usage);
 
    static void init(int argc, char **argv,
                    std::string parameterFileName,
                    const Usage& usage = [](const char *, const std::string &){});
 
    static void init(int argc, char **argv,
                     const DefaultParams& defaultParams,
                     const Usage& usage);
 
    static void init(int argc, char **argv,
                     const DefaultParams& defaultParams = [] (Dune::ParameterTree&) {},
                     std::string parameterFileName = "",
                     const Usage& usage = [](const char *, const std::string &){});
 
    static void init(const DefaultParams&  params = [] (Dune::ParameterTree&) {},
                     const DefaultParams& defaultParams = [] (Dune::ParameterTree&) {});
 
    static void init(const std::string& parameterFileName,
                     const DefaultParams& params = [] (Dune::ParameterTree&) {},
                     bool inputFileOverwritesParams = true,
                     const DefaultParams& defaultParams = [] (Dune::ParameterTree&) {});
 
    static void print();
 
    static Dune::ParameterTree parseCommandLine(int argc, char **argv);
 
    static const LoggingParameterTree& getTree();
 
private:
    static Dune::ParameterTree& paramTree_();
 
    static Dune::ParameterTree& defaultParamTree_();
 
    static void applyGlobalDefaults_(Dune::ParameterTree& params);
 
    static void mergeTree_(Dune::ParameterTree& target, const Dune::ParameterTree& source, bool overwrite = true);
 
    static void mergeTreeImpl_(Dune::ParameterTree& target, const Dune::ParameterTree& source, bool overwrite, const std::string& group);
};
 
template<typename T = std::string, typename... Args>
T getParam(Args&&... args)
{ return Parameters::getTree().template get<T>(std::forward<Args>(args)... ); }
 
template<typename T = std::string, typename... Args>
T getParamFromGroup(Args&&... args)
{ return Parameters::getTree().template getFromGroup<T>(std::forward<Args>(args)... ); }
 
inline bool hasParam(const std::string& param)
{ return Parameters::getTree().hasKey(param); }
 
inline bool hasParamInGroup(const std::string& paramGroup, const std::string& param)
{ return Parameters::getTree().hasKeyInGroup(param, paramGroup); }
 
inline std::vector<std::string> getParamSubGroups(const std::string& subGroupName, const std::string& paramGroup)
{ return Parameters::getTree().getSubGroups(subGroupName, paramGroup); }
 
} // end namespace Dumux
 
#endif