interface.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2025-2026 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_convective_heating_interface_h
#define _aspect_boundary_convective_heating_interface_h

#include <aspect/plugins.h>
#include <aspect/material_model/interface.h>
#include <aspect/boundary_temperature/interface.h>
#include <aspect/boundary_heat_flux/interface.h>
#include <aspect/utilities.h>

namespace aspect
{
  template <int dim> class SimulatorAccess;

  namespace BoundaryConvectiveHeating
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        std::vector<double>
        heat_transfer_coefficient (const types::boundary_id boundary_indicator,
                                   const MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                                   const MaterialModel::MaterialModelOutputs<dim> &material_model_outputs) 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_temperature (const types::boundary_id boundary_indicator,
                              const Point<dim> &position) const;

        std::vector<Tensor<1,dim>>
        heat_flux (const types::boundary_id boundary_indicator,
                   const MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                   const MaterialModel::MaterialModelOutputs<dim> &material_model_outputs,
                   const std::vector<Tensor<1,dim>> &normal_vectors) const;

        std::vector<double>
        heat_transfer_coefficient (const types::boundary_id boundary_indicator,
                                   const MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                                   const MaterialModel::MaterialModelOutputs<dim> &material_model_outputs) const;

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

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

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

        /*
         * Return a set of boundary indicators for which convective heating
         * is prescribed.
         */
        const std::set<types::boundary_id> &
        get_convective_heating_boundary_indicators() const;

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

        DeclException1 (ExcBoundaryConvectiveHeatingNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered boundary convective heating objects.");
      private:
        std::set<types::boundary_id> convective_heating_boundary_indicators;

        std::vector<std::string> temperature_plugin_names;

        std::vector<std::string> heat_flux_plugin_names;

        std::list<std::unique_ptr<aspect::BoundaryTemperature::Interface<dim>>> temperature_plugin_objects;

        std::list<std::unique_ptr<aspect::BoundaryHeatFlux::Interface<dim>>> heat_flux_plugin_objects;
    };


#define ASPECT_REGISTER_BOUNDARY_CONVECTIVE_HEATING_MODEL(classname, name, description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_BOUNDARY_CONVECTIVE_HEATING_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryConvectiveHeating::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::BoundaryConvectiveHeating::Manager<2>::register_boundary_convective_heating, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::BoundaryConvectiveHeating::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::BoundaryConvectiveHeating::Manager<3>::register_boundary_convective_heating, \
                                name, description); \
  }
  }
}


#endif