interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2023 by the authors of the ASPECT code.

  This file is part of ASPECT.

  ASPECT 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 2, or (at your option)
  any later version.

  ASPECT 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 ASPECT; see the file LICENSE.  If not see
  <http://www.gnu.org/licenses/>.
*/


#ifndef _aspect_initial_composition_interface_h
#define _aspect_initial_composition_interface_h

#include <aspect/plugins.h>
#include <aspect/utilities.h>
#include <aspect/simulator_access.h>

#include <deal.II/base/point.h>
#include <deal.II/base/parameter_handler.h>

#include <boost/core/demangle.hpp>
#include <typeinfo>


namespace aspect
{
  template <int dim> class SimulatorAccess;

  namespace InitialComposition
  {
    using namespace dealii;

    template <int dim>
    class Interface
    {
      public:
        virtual ~Interface() = default;

        virtual
        void
        initialize ();

        virtual
        double initial_composition (const Point<dim> &position, const unsigned int n_comp) const = 0;


        static
        void
        declare_parameters (ParameterHandler &prm);

        virtual
        void
        parse_parameters (ParameterHandler &prm);

    };



    template <int dim>
    class Manager : public ::aspect::SimulatorAccess<dim>
    {
      public:
        ~Manager () override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm);

        double
        initial_composition (const Point<dim> &position,
                             const unsigned int n_comp) const;

        static
        void
        register_initial_composition (const std::string &name,
                                      const std::string &description,
                                      void (*declare_parameters_function) (ParameterHandler &),
                                      std::unique_ptr<Interface<dim>> (*factory_function) ());


        const std::vector<std::string> &
        get_active_initial_composition_names () const;

        const std::list<std::unique_ptr<Interface<dim>>> &
        get_active_initial_composition_conditions () const;

        template <typename InitialCompositionType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,InitialCompositionType>::value>>
        bool
        has_matching_initial_composition_model () const;

        template <typename InitialCompositionType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,InitialCompositionType>::value>>
        const InitialCompositionType &
        get_matching_initial_composition_model () const;

        static
        void
        write_plugin_graph (std::ostream &output_stream);

        DeclException1 (ExcInitialCompositionNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered initial composition objects.");
      private:
        std::list<std::unique_ptr<Interface<dim>>> initial_composition_objects;

        std::vector<std::string> model_names;

        std::vector<aspect::Utilities::Operator> model_operators;
    };



    template <int dim>
    template <typename InitialCompositionType, typename>
    inline
    bool
    Manager<dim>::has_matching_initial_composition_model () const
    {
      for (const auto &p : initial_composition_objects)
        if (Plugins::plugin_type_matches<InitialCompositionType>(*p))
          return true;
      return false;
    }


    template <int dim>
    template <typename InitialCompositionType, typename>
    inline
    const InitialCompositionType &
    Manager<dim>::get_matching_initial_composition_model () const
    {
      AssertThrow(has_matching_initial_composition_model<InitialCompositionType> (),
                  ExcMessage("You asked InitialComposition::Manager::get_initial_composition_model() for a "
                             "initial composition model of type <" + boost::core::demangle(typeid(InitialCompositionType).name()) + "> "
                             "that could not be found in the current model. Activate this "
                             "initial composition model in the input file."));

      typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator initial_composition_model;
      for (const auto &p : initial_composition_objects)
        if (Plugins::plugin_type_matches<InitialCompositionType>(*p))
          return Plugins::get_plugin_as_type<InitialCompositionType>(*p);

      // We will never get here, because we had the Assert above. Just to avoid warnings.
      return Plugins::get_plugin_as_type<InitialCompositionType>(*(*initial_composition_model));
    }


    template <int dim>
    std::string
    get_valid_model_names_pattern ();



#define ASPECT_REGISTER_INITIAL_COMPOSITION_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_INITIAL_COMPOSITION_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::InitialComposition::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::InitialComposition::Manager<2>::register_initial_composition, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::InitialComposition::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::InitialComposition::Manager<3>::register_initial_composition, \
                                name, description); \
  }
  }
}


#endif