interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2024 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_prescribed_dilation_interface_h
#define _aspect_prescribed_dilation_interface_h

#include <aspect/plugins.h>
#include <aspect/simulator_access.h>
#include <aspect/utilities.h>
#include <aspect/material_model/interface.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 PrescribedDilation
  {

    template <int dim>
    class PrescribedDilationOutputs
    {
      public:
        PrescribedDilationOutputs (const unsigned int n_points);

        PrescribedDilationOutputs (const PrescribedDilationOutputs &source) = default;

        PrescribedDilationOutputs (PrescribedDilationOutputs &&)  noexcept = default;

        PrescribedDilationOutputs &operator= (const PrescribedDilationOutputs &source) = delete;

        PrescribedDilationOutputs &operator= (PrescribedDilationOutputs &&)  noexcept = default;

        unsigned int n_evaluation_points() const;

        void reset();

        std::vector<double> dilation;
    };


    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual void
        evaluate ( const aspect::MaterialModel::MaterialModelInputs<dim> &in,
                   PrescribedDilationOutputs<dim> &out) 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;


        void
        evaluate ( const aspect::MaterialModel::MaterialModelInputs<dim> &in,
                   PrescribedDilationOutputs<dim> &out) const;


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


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


        DeclException1 (ExcDilationModelNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered dilation model objects.");
    };


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


#define ASPECT_REGISTER_DILATION_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_DILATION_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::PrescribedDilation::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::PrescribedDilation::Manager<2>::register_dilation_model, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::PrescribedDilation::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::PrescribedDilation::Manager<3>::register_dilation_model, \
                                name, description); \
  }
  }
}


#endif