interface.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-2025 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------


#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
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        double initial_composition (const Point<dim> &position, const unsigned int n_comp) const = 0;
    };



    template <int dim>
    class Manager : public Plugins::ManagerBase<Interface<dim>>, public SimulatorAccess<dim>
    {
      public:
        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        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) ());


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

        DEAL_II_DEPRECATED
        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>>
        DEAL_II_DEPRECATED
        bool
        has_matching_initial_composition_model () const;

        template <typename InitialCompositionType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,InitialCompositionType>::value>>
        DEAL_II_DEPRECATED
        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::vector<aspect::Utilities::Operator> model_operators;
    };



    template <int dim>
    template <typename InitialCompositionType, typename>
    inline
    bool
    Manager<dim>::has_matching_initial_composition_model () const
    {
      return this->template has_matching_active_plugin<InitialCompositionType>();
    }


    template <int dim>
    template <typename InitialCompositionType, typename>
    inline
    const InitialCompositionType &
    Manager<dim>::get_matching_initial_composition_model () const
    {
      return this->template get_matching_active_plugin<InitialCompositionType>();
    }


    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