interface.h

Go to the documentation of this file.

/*
 Copyright (C) 2015 - 2025 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_particle_interpolator_interface_h
#define _aspect_particle_interpolator_interface_h

#include <aspect/particle/interface.h>
#include <aspect/global.h>

#include <deal.II/particles/particle.h>
#include <deal.II/particles/particle_handler.h>
#include <deal.II/base/point.h>
#include <deal.II/base/parameter_handler.h>
#include <deal.II/distributed/tria.h>
#include <deal.II/fe/component_mask.h>

namespace aspect
{
  namespace Particle
  {
    namespace Interpolator
    {
      using namespace ::Particles;

      template <int dim>
      class Interface : public ParticleInterfaceBase
      {
        public:
          virtual
          std::vector<std::vector<double>>
          properties_at_points(const ParticleHandler<dim> &particle_handler,
                               const std::vector<Point<dim>> &positions,
                               const ComponentMask &selected_properties,
                               const typename parallel::distributed::Triangulation<dim>::active_cell_iterator &cell) const = 0;
      };


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


      template <int dim>
      void
      register_particle_interpolator (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_particle_interpolator (const std::string &interpolator_name);


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


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


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

#define ASPECT_REGISTER_PARTICLE_INTERPOLATOR(classname, name, description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_PARTICLE_INTERPOLATOR_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Interpolator::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::Particle::Interpolator::register_particle_interpolator<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Interpolator::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::Particle::Interpolator::register_particle_interpolator<3>, \
                                name, description); \
  }
    }
  }
}


#endif