parameter_acceptor.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2017 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_base_parameter_acceptor_h
#define dealii_base_parameter_acceptor_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/observer_pointer.h>
#include <deal.II/base/parameter_handler.h>
 
#include <boost/signals2/signal.hpp>
 
#include <mutex>
#include <set>
#include <typeinfo>
 
DEAL_II_NAMESPACE_OPEN
 
class ParameterAcceptor;
 
namespace internal
{
  struct ParameterAcceptorCompare;
} // namespace internal
 
class ParameterAcceptor : public EnableObserverPointer
{
public:
  ParameterAcceptor(const std::string &section_name = "");
 
  unsigned int
  get_acceptor_id() const;
 
  virtual ~ParameterAcceptor() override;
 
  static void
  initialize(const std::string &filename        = "",
             const std::string &output_filename = "",
             const ParameterHandler::OutputStyle
               output_style_for_output_filename      = ParameterHandler::Short,
             ParameterHandler                   &prm = ParameterAcceptor::prm,
             const ParameterHandler::OutputStyle output_style_for_filename =
               ParameterHandler::DefaultStyle);
 
  static void
  initialize(std::istream     &input_stream,
             ParameterHandler &prm = ParameterAcceptor::prm);
 
 
  static void
  clear();
 
  virtual void
  declare_parameters(ParameterHandler &prm);
 
  boost::signals2::signal<void()> declare_parameters_call_back;
 
  virtual void
  parse_parameters(ParameterHandler &prm);
 
  boost::signals2::signal<void()> parse_parameters_call_back;
 
  static void
  parse_all_parameters(ParameterHandler &prm = ParameterAcceptor::prm);
 
  static void
  declare_all_parameters(ParameterHandler &prm = ParameterAcceptor::prm);
 
  std::string
  get_section_name() const;
 
  std::vector<std::string>
  get_section_path() const;
 
  template <typename ParameterType>
  void
  add_parameter(const std::string           &entry,
                ParameterType               &parameter,
                const std::string           &documentation = "",
                ParameterHandler            &prm_          = prm,
                const Patterns::PatternBase &pattern =
                  *Patterns::Tools::Convert<ParameterType>::to_pattern());
 
  static ParameterHandler prm;
 
  void
  enter_subsection(const std::string &subsection);
 
  void
  leave_subsection();
 
  void
  enter_my_subsection(ParameterHandler &prm);
 
  void
  leave_my_subsection(ParameterHandler &prm);
 
private:
  static unsigned int
  get_next_free_id();
 
  static std::mutex class_list_mutex;
 
  static std::set<ParameterAcceptor *, internal::ParameterAcceptorCompare>
    class_list;
 
  const unsigned int acceptor_id;
 
  static const char sep = '/';
 
protected:
  const std::string section_name;
 
  std::vector<std::string> subsections;
};
 
 
 
template <class SourceClass>
class ParameterAcceptorProxy : public SourceClass, public ParameterAcceptor
{
public:
  template <typename... Args>
  ParameterAcceptorProxy(const std::string &section_name, Args... args);
 
  virtual void
  declare_parameters(ParameterHandler &prm) override;
 
  virtual void
  parse_parameters(ParameterHandler &prm) override;
};
 
 
 
// Inline and template functions
template <typename ParameterType>
void
ParameterAcceptor::add_parameter(const std::string           &entry,
                                 ParameterType               &parameter,
                                 const std::string           &documentation,
                                 ParameterHandler            &prm,
                                 const Patterns::PatternBase &pattern)
{
  enter_my_subsection(prm);
  prm.add_parameter(entry, parameter, documentation, pattern);
  leave_my_subsection(prm);
}
 
 
 
template <class SourceClass>
template <typename... Args>
ParameterAcceptorProxy<SourceClass>::ParameterAcceptorProxy(
  const std::string &section_name,
  Args... args)
  : SourceClass(args...)
  , ParameterAcceptor(section_name)
{}
 
 
 
template <class SourceClass>
void
ParameterAcceptorProxy<SourceClass>::declare_parameters(ParameterHandler &prm)
{
  SourceClass::declare_parameters(prm);
}
 
 
 
template <class SourceClass>
void
ParameterAcceptorProxy<SourceClass>::parse_parameters(ParameterHandler &prm)
{
  SourceClass::parse_parameters(prm);
}
 
DEAL_II_NAMESPACE_CLOSE
 
#endif