Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
update_fine_search_candidates.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_update_fine_search_candidates_h
5#define lethe_update_fine_search_candidates_h
6
7#include <dem/contact_type.h>
8
9/**
10 * @brief Manage removing repetitions and adding new contact pairs to the
11 * contact containers when particles are exchanged between processors. If the
12 * contact pair (in adjacent particles containers) does not exist in the output
13 * of the new (current step) broad search, it is removed from the contact pair
14 * (adjacent containers), since it means that the contact is being handled by
15 * another processor. If the pair exists in the output of the new broad search,
16 * it is removed from the output of the broad search, as the contact is already
17 * being processed. This process is performed for many types of particle-object
18 * pairs : local-local particle-particle pairs, local-ghost particle-particle
19 * pairs and particle-wall pairs, particle-floating wall pairs and
20 * particle-floating mesh contacts pairs. Note : contact_type is important for
21 * local or ghost particle-particle contact only
22 *
23 * @tparam pairs_structure Adjacent particle-object pairs container type.
24 * @tparam candidates_structure Particle-object contact pairs container type.
25 * @tparam contact_type Label of contact type to apply proper manipulation of
26 * contact removal in containers.
27 *
28 * @param[in,out] pairs_in_contact adjacent particle-object pairs from fine
29 * search at previous time step.
30 * @param[in,out] contact_candidates particle-object contact pairs from board
31 * search at current time step.
32 */
33template <int dim,
34 typename pairs_structure,
35 typename candidates_structure,
36 ContactType contact_type>
37void
38update_fine_search_candidates(pairs_structure &pairs_in_contact,
39 candidates_structure &contact_candidates);
40
41#endif
ContactType
Label for particle-object contact type.
void update_fine_search_candidates(pairs_structure &pairs_in_contact, candidates_structure &contact_candidates)
Manage removing repetitions and adding new contact pairs to the contact containers when particles are...