interface.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2013-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_composition_interface_h
#define _aspect_boundary_composition_interface_h

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

#include <deal.II/base/parameter_handler.h>
#include <deal.II/distributed/tria.h>

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


namespace aspect
{
  namespace BoundaryComposition
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        double
        boundary_composition (const types::boundary_id boundary_indicator,
                              const Point<dim> &position,
                              const unsigned int compositional_field) 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
        boundary_composition (const types::boundary_id boundary_indicator,
                              const Point<dim> &position,
                              const unsigned int compositional_field) const;

        static
        void
        register_boundary_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_boundary_composition_names () const;

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

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

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

        /*
         * Return a set of boundary indicators for which boundary
         * compositions are prescribed.
         */
        const std::set<types::boundary_id> &
        get_fixed_composition_boundary_indicators() const;

        /*
         * Return whether Dirichlet boundary conditions will be applied
         * on parts of the boundaries where material flows out.
         */
        bool
        allows_fixed_composition_on_outflow_boundaries() const;

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


        DeclException1 (ExcBoundaryCompositionNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered boundary composition objects.");
      private:
        std::vector<aspect::Utilities::Operator> model_operators;

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

        bool allow_fixed_composition_on_outflow_boundaries;
    };



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



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



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


#define ASPECT_REGISTER_BOUNDARY_COMPOSITION_MODEL(classname, name, description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_BOUNDARY_COMPOSITION_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryComposition::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::BoundaryComposition::Manager<2>::register_boundary_composition, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryComposition::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::BoundaryComposition::Manager<3>::register_boundary_composition, \
                                name, description); \
  }
  }
}


#endif