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_traction_interface_h
#define _aspect_boundary_traction_interface_h

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

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

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

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

        DEAL_II_DEPRECATED
        const std::map<types::boundary_id, std::pair<std::string,std::vector<std::string>>> &
        get_active_boundary_traction_names () const;

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

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

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

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

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

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


        DeclException1 (ExcBoundaryTractionNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered boundary traction objects.");

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

      private:
        std::vector<types::boundary_id> boundary_indicators;

        std::vector<ComponentMask> component_masks;

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

        std::map<types::boundary_id,std::vector<std::unique_ptr<BoundaryTraction::Interface<dim>>>> boundary_traction_objects;

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

    };

    template <int dim>
    std::unique_ptr<Interface<dim>>
    create_boundary_traction (const std::string &name);

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

    template <int dim>
    void
    declare_parameters (ParameterHandler &prm);


    template <int dim>
    void
    write_plugin_graph (std::ostream &output_stream);



#define ASPECT_REGISTER_BOUNDARY_TRACTION_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_BOUNDARY_TRACTION_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryTraction::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::BoundaryTraction::Manager<2>::register_boundary_traction, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryTraction::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::BoundaryTraction::Manager<3>::register_boundary_traction, \
                                name, description); \
  }
  }
}


#endif