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_gravity_model_interface_h
#define _aspect_gravity_model_interface_h

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

namespace aspect
{
  namespace GravityModel
  {
    using namespace dealii;

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

        virtual void initialize ();

        virtual Tensor<1,dim> gravity_vector (const Point<dim> &position) const = 0;

        virtual void update();

        static
        void
        declare_parameters (ParameterHandler &prm);

        virtual
        void
        parse_parameters (ParameterHandler &prm);
    };




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

    template <int dim>
    std::unique_ptr<Interface<dim>>
    create_gravity_model (ParameterHandler &prm);


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


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


#define ASPECT_REGISTER_GRAVITY_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_GRAVITY_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::GravityModel::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::GravityModel::register_gravity_model<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::GravityModel::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::GravityModel::register_gravity_model<3>, \
                                name, description); \
  }
  }
}


#endif