constants.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2022 by Luca Heltai
//
// This file is part of the FSI-suite platform, based on the deal.II library.
//
// The FSI-suite platform is free software; you can use it, redistribute it,
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 3.0 of the License,
// or (at your option) any later version. The full text of the license can be
// found in the file LICENSE at the top level of the FSI-suite platform
// distribution.
//
// ---------------------------------------------------------------------
 
#ifndef parsed_tools_constants_h
#define parsed_tools_constants_h
 
#include <deal.II/base/parameter_acceptor.h>
 
#include <deal.II/differentiation/sd.h>
 
namespace ParsedTools
{
  class Constants : public dealii::ParameterAcceptor
  {
  public:
    Constants(
      const std::string              &section_name                      = "",
      const std::vector<std::string> &names                             = {},
      const std::vector<double>      &default_values                    = {},
      const std::vector<std::string> &optional_names_for_parameter_file = {},
      const std::vector<std::string> &optional_documentation_strings    = {});
 
    operator const std::map<std::string, double> &() const;
 
#ifdef DEAL_II_WITH_SYMENGINE
    operator const dealii::Differentiation::SD::types::substitution_map &()
      const;
#endif
 
    const double &
    operator[](const std::string &key) const;
 
  private:
    std::map<std::string, double> constants;
 
 
#ifdef DEAL_II_WITH_SYMENGINE
    mutable dealii::Differentiation::SD::types::substitution_map
      constant_substitution_map;
#endif
 
 
    std::map<std::string, std::string> constants_parameter_entries;
 
    std::map<std::string, std::string> constants_documentation;
  };
} // namespace ParsedTools
#endif