generators.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2019 - 2026 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_particles_particle_generator_h
#define dealii_particles_particle_generator_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/function.h>
#include <deal.II/base/quadrature.h>
 
#include <deal.II/distributed/tria.h>
 
#include <deal.II/dofs/dof_handler.h>
 
#include <deal.II/fe/mapping.h>
 
#include <deal.II/particles/particle.h>
#include <deal.II/particles/particle_handler.h>
 
#include <random>
 
DEAL_II_NAMESPACE_OPEN
 
namespace Particles
{
  namespace Generators
  {
    template <int dim, int spacedim = dim>
    void
    regular_reference_locations(
      const Triangulation<dim, spacedim> &triangulation,
      const std::vector<Point<dim>>      &particle_reference_locations,
      ParticleHandler<dim, spacedim>     &particle_handler,
      const Mapping<dim, spacedim>       &mapping =
        (ReferenceCells::get_hypercube<dim>()
#ifndef _MSC_VER
           .template get_default_linear_mapping<spacedim>()
#else
           .ReferenceCell<dim>::get_default_linear_mapping<spacedim>()
#endif
           ));
 
    template <int dim, int spacedim = dim>
    Particle<dim, spacedim>
    random_particle_in_cell(
      const typename Triangulation<dim, spacedim>::active_cell_iterator &cell,
      const types::particle_index                                        id,
      std::mt19937                 &random_number_generator,
      const Mapping<dim, spacedim> &mapping =
        (ReferenceCells::get_hypercube<dim>()
#ifndef _MSC_VER
           .template get_default_linear_mapping<spacedim>()
#else
           .ReferenceCell<dim>::get_default_linear_mapping<spacedim>()
#endif
           ));
 
    template <int dim, int spacedim = dim>
    ParticleIterator<dim, spacedim>
    random_particle_in_cell_insert(
      const typename Triangulation<dim, spacedim>::active_cell_iterator &cell,
      const types::particle_index                                        id,
      std::mt19937                   &random_number_generator,
      ParticleHandler<dim, spacedim> &particle_handler,
      const Mapping<dim, spacedim>   &mapping =
        (ReferenceCells::get_hypercube<dim>()
#ifndef _MSC_VER
           .template get_default_linear_mapping<spacedim>()
#else
           .ReferenceCell<dim>::get_default_linear_mapping<spacedim>()
#endif
           ));
 
    template <int dim, int spacedim = dim>
    void
    probabilistic_locations(
      const Triangulation<dim, spacedim> &triangulation,
      const Function<spacedim>           &probability_density_function,
      const bool                          random_cell_selection,
      const types::particle_index         n_particles_to_create,
      ParticleHandler<dim, spacedim>     &particle_handler,
      const Mapping<dim, spacedim>       &mapping =
        (ReferenceCells::get_hypercube<dim>()
#ifndef _MSC_VER
           .template get_default_linear_mapping<spacedim>()),
#else
           .ReferenceCell<dim>::get_default_linear_mapping<spacedim>()),
#endif
      const unsigned int random_number_seed = 5432);
 
 
    template <int dim, int spacedim = dim>
    void
    dof_support_points(const DoFHandler<dim, spacedim> &dof_handler,
                       const std::vector<std::vector<BoundingBox<spacedim>>>
                                                      &global_bounding_boxes,
                       ParticleHandler<dim, spacedim> &particle_handler,
                       const Mapping<dim, spacedim>   &mapping =
                         (ReferenceCells::get_hypercube<dim>()
#ifndef _MSC_VER
                            .template get_default_linear_mapping<spacedim>()),
#else
                            .ReferenceCell<dim>::get_default_linear_mapping<
                              spacedim>()),
#endif
                       const ComponentMask                    &components = {},
                       const std::vector<std::vector<double>> &properties = {});
 
    template <int dim, int spacedim = dim>
    void
    quadrature_points(const Triangulation<dim, spacedim> &triangulation,
                      const Quadrature<dim>              &quadrature,
                      const std::vector<std::vector<BoundingBox<spacedim>>>
                                                     &global_bounding_boxes,
                      ParticleHandler<dim, spacedim> &particle_handler,
                      const Mapping<dim, spacedim>   &mapping =
                        (ReferenceCells::get_hypercube<dim>()
                           .template get_default_linear_mapping<spacedim>()),
                      const std::vector<std::vector<double>> &properties = {});
  } // namespace Generators
} // namespace Particles
 
DEAL_II_NAMESPACE_CLOSE
 
#endif