interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2022 by the authors of the ASPECT code.

  This file is part of ASPECT.

  ASPECT is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2, or (at your option)
  any later version.

  ASPECT is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ASPECT; see the file LICENSE.  If not see
  <http://www.gnu.org/licenses/>.
*/


#ifndef _aspect_heating_model_interface_h
#define _aspect_heating_model_interface_h

#include <aspect/plugins.h>
#include <aspect/material_model/interface.h>
#include <aspect/simulator_access.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
{
  template <int dim> class SimulatorAccess;
  namespace HeatingModel
  {
    using namespace dealii;

    struct HeatingModelOutputs
    {
      HeatingModelOutputs (const unsigned int n_points,
                           const unsigned int n_comp);

      std::vector<double> heating_source_terms;

      std::vector<double> rates_of_temperature_change;

      std::vector<double> lhs_latent_heat_terms;

      void
      reset ();
    };

    template <int dim>
    class Interface
    {
      public:
        virtual ~Interface() = default;

        virtual
        void
        initialize ();

        virtual
        void
        update ();

        virtual
        void
        evaluate (const MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                  const MaterialModel::MaterialModelOutputs<dim> &material_model_outputs,
                  HeatingModel::HeatingModelOutputs &heating_model_outputs) const;

        DEAL_II_DEPRECATED
        virtual
        double
        specific_heating_rate (const double temperature,
                               const double pressure,
                               const std::vector<double> &compositional_fields,
                               const Point<dim> &position) const;

        static
        void
        declare_parameters (ParameterHandler &prm);

        virtual
        void
        parse_parameters (ParameterHandler &prm);


        virtual
        void
        create_additional_material_model_outputs(MaterialModel::MaterialModelOutputs<dim> &outputs) const;

        virtual
        void
        create_additional_material_model_inputs(MaterialModel::MaterialModelInputs<dim> &inputs) const;
    };


    template <int dim>
    class Manager : public ::aspect::SimulatorAccess<dim>
    {
      public:
        ~Manager () override;

        bool
        adiabatic_heating_enabled() const;

        bool
        shear_heating_enabled() const;

        static
        void
        declare_parameters (ParameterHandler &prm);


        void
        parse_parameters (ParameterHandler &prm);

        void
        update ();


        void
        evaluate (const MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                  const MaterialModel::MaterialModelOutputs<dim> &material_model_outputs,
                  HeatingModel::HeatingModelOutputs &heating_model_outputs) const;

        virtual
        void
        create_additional_material_model_inputs_and_outputs(MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                                                            MaterialModel::MaterialModelOutputs<dim> &material_model_outputs) const;


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


        const std::vector<std::string> &
        get_active_heating_model_names () const;

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

        template <typename HeatingModelType>
        DEAL_II_DEPRECATED
        HeatingModelType *
        find_heating_model () const;

        template <typename HeatingModelType>
        bool
        has_matching_heating_model () const;

        template <typename HeatingModelType>
        const HeatingModelType &
        get_matching_heating_model () const;


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

        DeclException1 (ExcHeatingModelNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered heating model objects.");
      private:
        std::list<std::unique_ptr<Interface<dim>>> heating_model_objects;

        std::vector<std::string> model_names;
    };



    template <int dim>
    template <typename HeatingModelType>
    inline
    HeatingModelType *
    Manager<dim>::find_heating_model () const
    {
      for (auto &p : heating_model_objects)
        if (HeatingModelType *x = dynamic_cast<HeatingModelType *> (p.get()))
          return x;
      return nullptr;
    }


    template <int dim>
    template <typename HeatingModelType>
    inline
    bool
    Manager<dim>::has_matching_heating_model () const
    {
      for (const auto &p : heating_model_objects)
        if (Plugins::plugin_type_matches<HeatingModelType>(*p))
          return true;
      return false;
    }


    template <int dim>
    template <typename HeatingModelType>
    inline
    const HeatingModelType &
    Manager<dim>::get_matching_heating_model () const
    {
      AssertThrow(has_matching_heating_model<HeatingModelType> (),
                  ExcMessage("You asked HeatingModel::Manager::get_heating_model() for a "
                             "heating model of type <" + boost::core::demangle(typeid(HeatingModelType).name()) + "> "
                             "that could not be found in the current model. Activate this "
                             "heating model in the input file."));

      typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator heating_model;
      for (typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator
           p = heating_model_objects.begin();
           p != heating_model_objects.end(); ++p)
        if (Plugins::plugin_type_matches<HeatingModelType>(*(*p)))
          return Plugins::get_plugin_as_type<HeatingModelType>(*(*p));

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


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


#define ASPECT_REGISTER_HEATING_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_HEATING_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::HeatingModel::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::HeatingModel::Manager<2>::register_heating_model, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::HeatingModel::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::HeatingModel::Manager<3>::register_heating_model, \
                                name, description); \
  }
  }
}


#endif