Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
particle_point_line_broad_search.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2020, 2022-2025 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_particle_point_line_broad_search_h
5#define lethe_particle_point_line_broad_search_h
6
8#include <dem/contact_info.h>
10
11#include <deal.II/particles/particle_iterator.h>
12
13using namespace dealii;
14
15/**
16 * @brief Find a map of pairs (pair of particle and the boundary vertex
17 * location) which shows the candidate particle-point collision pairs. These
18 * collision pairs will be investigated in the fine search to check if they
19 * are in contact or not.
20 *
21 * @param particle_handler Particle handler of particles located in boundary
22 * cells.
23 * @param boundary_cells_with_points A container of cells which are located at
24 * boundaries with only one vertex.
25 * @param particle_point_contact_candidates The map of particle-point pairs.
26 * Each element of map (pair) contains a contact pair particle located near
27 * boundaries with vertices and the vertex location.
28 */
29template <int dim>
30void
32 const Particles::ParticleHandler<dim> &particle_handler,
33 const std::unordered_map<std::string, cell_point_info<dim>>
34 &boundary_cells_with_points,
36 &particle_point_contact_candidates);
37
38/**
39 * @brief Find a map of pairs (pair of particle and the boundary vertex
40 * location) which shows the candidate particle-point collision pairs. These
41 * collision pairs will be investigated in the fine search to check if they
42 * are in contact or not.
43 *
44 * @tparam dim An integer that denotes the number of spatial dimensions.
45 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
46 *
47 * @param particle_handler Particle handler of particles located in boundary
48 * cells.
49 * @param boundary_cells_with_points A container of cells which are located at
50 * boundaries with only one vertex.
51 * @param particle_point_contact_candidates The map of particle-point pairs.
52 * Each element of map (pair) contains a contact pair particle located near
53 * boundaries with vertices and the vertex location.
54 * @param sparse_contacts_object The Adaptive Sparse Contacts for mobility
55 * status checks.
56 */
57template <int dim, typename PropertiesIndex>
58void
60 const Particles::ParticleHandler<dim> &particle_handler,
61 const std::unordered_map<std::string, cell_point_info<dim>>
62 &boundary_cells_with_points,
64 &particle_point_contact_candidates,
65 const AdaptiveSparseContacts<dim, PropertiesIndex> &sparse_contacts_object);
66
67/**
68 * @brief Find a map of tuples (tuple of particle and the locations of
69 * beginning and ending vertices of the boundary lines) which shows the
70 * candidate particle-line collision pairs. These collision pairs will be
71 * investigated in the fine search to check if they are in contact or not.
72 *
73 * @param particle_handler Particle handler of particles located in boundary
74 * cells.
75 * @param boundary_cells_with_lines A container of cells which are located at
76 * boundaries with only one line.
77 * @param particle_line_contact_candidates Each element of map (tuple) contains
78 * a particle and the locations of beginning and ending vertices of the boundary
79 * lines.
80 */
81template <int dim>
82void
84 const Particles::ParticleHandler<dim> &particle_handler,
85 const std::unordered_map<std::string, cell_line_info<dim>>
86 &boundary_cells_with_lines,
88 &particle_line_contact_candidates);
89
90/**
91 * @brief Find a map of tuples (tuple of particle and the locations of
92 * beginning and ending vertices of the boundary lines) which shows the
93 * candidate particle-line collision pairs. These collision pairs will be
94 * investigated in the fine search to check if they are in contact or not.
95 *
96 * @tparam dim An integer that denotes the number of spatial dimensions.
97 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
98 *
99 * @param particle_handler Particle handler of particles located in boundary
100 * cells.
101 * @param boundary_cells_with_lines A container of cells which are located at
102 * boundaries with only one line.
103 * @param particle_line_contact_candidates Each element of map (tuple) contains
104 * a particle and the locations of beginning and ending vertices of the boundary
105 * lines.
106 * @param sparse_contacts_object The Adaptive Sparse Contacts for mobility
107 * status checks.
108 */
109template <int dim, typename PropertiesIndex>
110void
112 const Particles::ParticleHandler<dim> &particle_handler,
113 const std::unordered_map<std::string, cell_line_info<dim>>
114 &boundary_cells_with_lines,
116 &particle_line_contact_candidates,
117 const AdaptiveSparseContacts<dim, PropertiesIndex> &sparse_contacts_object);
118
119#endif
Mechanism that disables contacts computation through mobility status of cells based on granular tempe...
void find_particle_line_contact_pairs(const Particles::ParticleHandler< dim > &particle_handler, const std::unordered_map< std::string, cell_line_info< dim > > &boundary_cells_with_lines, typename DEM::dem_data_structures< dim >::particle_line_candidates &particle_line_contact_candidates)
Find a map of tuples (tuple of particle and the locations of beginning and ending vertices of the bou...
void find_particle_point_contact_pairs(const Particles::ParticleHandler< dim > &particle_handler, const std::unordered_map< std::string, cell_point_info< dim > > &boundary_cells_with_points, typename DEM::dem_data_structures< dim >::particle_point_candidates &particle_point_contact_candidates)
Find a map of pairs (pair of particle and the boundary vertex location) which shows the candidate par...
std::unordered_map< types::particle_index, particle_line_contact_info< dim > > particle_line_candidates
std::unordered_map< types::particle_index, particle_point_contact_info< dim > > particle_point_candidates
Handle information related to the cell-line matching.
Handle information related to the cell-point matching.