Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
particle_point_line_fine_search.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2020, 2022, 2024 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_fine_search_h
5#define lethe_particle_point_line_fine_search_h
6
8
9using namespace dealii;
10
11/**
12 * @brief Iterate over a map of pairs (particle_point_contact_candidates)
13 * to see if the particle-point pairs are in contact or not. If they are in
14 * contact, the normal overlap, normal vector of contact and contact normal
15 * relative velocity are stored in a map which is the output of this function.
16 *
17 * @tparam dim An integer that denotes the number of spatial dimensions.
18 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
19 *
20 * @param particle_point_contact_candidates The output of particle-point broad
21 * search which shows contact pair candidates.
22 * @param neighborhood_threshold A value which defines the neighbor particles.
23 * @param particle_point_pairs_in_contact A map which contains all the required
24 * information (normal overlap, normal vector and contact normal relative
25 * velocity) for calculation of particle-point contact force.
26 */
27template <int dim, typename PropertiesIndex>
28void
31 &particle_point_contact_candidates,
32 const double neighborhood_threshold,
34 &particle_point_pairs_in_contact);
35
36/**
37 * @brief Iterate over a map of tuples (particle_line_contact_candidates) to
38 * see if the particle-line pairs are in contact or not. If they are in
39 * contact, the normal overlap, normal vector of contact and contact normal
40 * relative velocity are stored in a map which is the output of this function.
41 *
42 * @tparam dim An integer that denotes the number of spatial dimensions.
43 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
44 *
45 * @param particle_line_contact_candidates The output of particle-line broad
46 * search which shows contact pair candidates.
47 * @param neighborhood_threshold A value which defines the neighbor particles.
48 * @param particle_line_pairs_in_contact A map which contains all the required
49 * information (normal overlap, normal vector and contact normal relative
50 * velocity) for calculation of particle-line contact force.
51 */
52template <int dim, typename PropertiesIndex>
53void
56 &particle_line_contact_candidates,
57 const double neighborhood_threshold,
59 &particle_line_pairs_in_contact);
60
61/**
62 * @brief This private function is used to find the projection of point_p on
63 * a line with beginning and ending vertices of point_a and point_b,
64 * respectively
65 *
66 * @param point_p A point which is going to be projected on the line
67 * @param point_a Beginning point of the line
68 * @param point_b Ending point of the line
69 *
70 * @return The projection of point_p on the line (from point_a to point_b)
71 */
72inline Point<3>
73find_projection_point(const Point<3> &point_p,
74 const Point<3> &point_a,
75 const Point<3> &point_b);
76
77#endif
Point< 3 > find_projection_point(const Point< 3 > &point_p, const Point< 3 > &point_a, const Point< 3 > &point_b)
This private function is used to find the projection of point_p on a line with beginning and ending v...
void particle_line_fine_search(const typename DEM::dem_data_structures< dim >::particle_line_candidates &particle_line_contact_candidates, const double neighborhood_threshold, typename DEM::dem_data_structures< dim >::particle_line_in_contact &particle_line_pairs_in_contact)
Iterate over a map of tuples (particle_line_contact_candidates) to see if the particle-line pairs are...
void particle_point_fine_search(const typename DEM::dem_data_structures< dim >::particle_point_candidates &particle_point_contact_candidates, const double neighborhood_threshold, typename DEM::dem_data_structures< dim >::particle_point_in_contact &particle_point_pairs_in_contact)
Iterate over a map of pairs (particle_point_contact_candidates) to see if the particle-point pairs ar...
std::unordered_map< types::particle_index, particle_line_contact_info< dim > > particle_line_candidates
std::unordered_map< types::particle_index, particle_line_contact_info< dim > > particle_line_in_contact
std::unordered_map< types::particle_index, particle_point_contact_info< dim > > particle_point_candidates
std::unordered_map< types::particle_index, particle_point_contact_info< dim > > particle_point_in_contact