interface.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2015-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_particle_generator_interface_h
#define _aspect_particle_generator_interface_h

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

#include <deal.II/particles/particle.h>
#include <deal.II/particles/generators.h>
#include <deal.II/base/parameter_handler.h>

#include <random>

#include <map>

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

      DeclExceptionMsg (ExcParticlePointNotInDomain,
                        "You requested to generate a particle at a position that "
                        "is not owned by this process, therefore the "
                        "Particle::Generator::Interface::generate_particle() function "
                        "refused to create it. You can circumvent this error message "
                        "by catching the ExcParticlePointNotInDomain exception and "
                        "do whatever you think is appropriate in this case.");

      template <int dim>
      class Interface : public SimulatorAccess<dim>, public ParticleInterfaceBase
      {
        public:
          void
          initialize() override;

          void
          update() override;

          virtual
          void
          generate_particles(Particles::ParticleHandler<dim> &particle_handler) = 0;

          std::pair<Particles::internal::LevelInd,Particle<dim>>
          generate_particle (const typename parallel::distributed::Triangulation<dim>::active_cell_iterator &cell,
                             const types::particle_index id);

          std::pair<Particles::internal::LevelInd,Particle<dim>>
          generate_particle (const typename parallel::distributed::Triangulation<dim>::active_cell_iterator &cell,
                             const types::particle_index id,
                             const Point<dim> &reference_position);

        protected:
          DEAL_II_DEPRECATED
          std::pair<Particles::internal::LevelInd,Particle<dim>>
          generate_particle(const Point<dim> &position,
                            const types::particle_index id) const;

          Particles::ParticleIterator<dim>
          insert_particle_at_position(const Point<dim> &position,
                                      const types::particle_index id,
                                      Particles::ParticleHandler<dim> &particle_handler) const;

          std::mt19937            random_number_generator;
      };

      template <int dim>
      void
      register_particle_generator (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_generator (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_GENERATOR(classname, name, description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_PARTICLE_GENERATOR_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Generator::Interface<2>,classname<2 >> \
    dummy_ ## classname ## _2d (&aspect::Particle::Generator::register_particle_generator<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Generator::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::Particle::Generator::register_particle_generator<3>, \
                                name, description); \
  }
    }
  }
}

#endif