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_boundary_velocity_interface_h
#define _aspect_boundary_velocity_interface_h

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

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

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


namespace aspect
{
  namespace BoundaryVelocity
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        Tensor<1,dim>
        boundary_velocity (const types::boundary_id boundary_indicator,
                           const Point<dim> &position) const = 0;
    };

    template <int dim>
    class Manager : public Plugins::ManagerBase<Interface<dim>>, public SimulatorAccess<dim>
    {
      public:
        Tensor<1,dim>
        boundary_velocity (const types::boundary_id boundary_indicator,
                           const Point<dim> &position) const;

        static
        void
        register_boundary_velocity (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::map<types::boundary_id, std::pair<std::string,std::vector<std::string>>> &
        get_active_boundary_velocity_names () const;

        DEAL_II_DEPRECATED
        const std::map<types::boundary_id,std::vector<std::unique_ptr<BoundaryVelocity::Interface<dim>>>> &
        get_active_boundary_velocity_conditions () const;

        const std::vector<types::boundary_id> &
        get_active_plugin_boundary_indicators() const;

        ComponentMask
        get_component_mask(const types::boundary_id boundary_id) const;

        const std::set<types::boundary_id> &
        get_prescribed_boundary_velocity_indicators () const;

        const std::set<types::boundary_id> &
        get_zero_boundary_velocity_indicators () const;

        const std::set<types::boundary_id> &
        get_tangential_boundary_velocity_indicators () const;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        template <typename BoundaryVelocityType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,BoundaryVelocityType>::value>>
        DEAL_II_DEPRECATED
        bool
        has_matching_boundary_velocity_model () const;

        template <typename BoundaryVelocityType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,BoundaryVelocityType>::value>>
        DEAL_II_DEPRECATED
        const BoundaryVelocityType &
        get_matching_boundary_velocity_model () const;

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


        DeclException1 (ExcBoundaryVelocityNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered boundary velocity objects.");
      private:
        std::vector<types::boundary_id> boundary_indicators;

        std::vector<ComponentMask> component_masks;

        std::map<types::boundary_id,std::vector<std::unique_ptr<BoundaryVelocity::Interface<dim>>>> boundary_velocity_objects;

        std::map<types::boundary_id, std::pair<std::string,std::vector<std::string>>> boundary_velocity_indicators;

        std::set<types::boundary_id> prescribed_velocity_boundary_indicators;

        std::set<types::boundary_id> zero_velocity_boundary_indicators;

        std::set<types::boundary_id> tangential_velocity_boundary_indicators;
    };



    template <int dim>
    template <typename BoundaryVelocityType, typename>
    inline
    bool
    Manager<dim>::has_matching_boundary_velocity_model () const
    {
      for (const auto &boundary : boundary_velocity_objects)
        for (const auto &p : boundary.second)
          if (Plugins::plugin_type_matches<BoundaryVelocityType>(*p))
            return true;
      return false;
    }


    template <int dim>
    template <typename BoundaryVelocityType, typename>
    inline
    const BoundaryVelocityType &
    Manager<dim>::get_matching_boundary_velocity_model () const
    {
      AssertThrow(has_matching_boundary_velocity_model<BoundaryVelocityType> (),
                  ExcMessage("You asked BoundaryVelocity::Manager::get_boundary_velocity_model() for a "
                             "boundary velocity model of type <" + boost::core::demangle(typeid(BoundaryVelocityType).name()) + "> "
                             "that could not be found in the current model. Activate this "
                             "boundary velocity model in the input file."));

      for (const auto &boundary : boundary_velocity_objects)
        for (const auto &p : boundary)
          if (Plugins::plugin_type_matches<BoundaryVelocityType>(*p))
            return Plugins::get_plugin_as_type<BoundaryVelocityType>(*p);

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


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


#define ASPECT_REGISTER_BOUNDARY_VELOCITY_MODEL(classname, name, description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_BOUNDARY_VELOCITY_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryVelocity::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::BoundaryVelocity::Manager<2>::register_boundary_velocity, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryVelocity::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::BoundaryVelocity::Manager<3>::register_boundary_velocity, \
                                name, description); \
  }
  }
}


#endif