Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
find_contact_detection_step.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2020-2025 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_find_contact_detection_step_h
5#define lethe_find_contact_detection_step_h
6
7#include <core/serial_solid.h>
8
9#include <deal.II/particles/particle_handler.h>
10
11#include <vector>
12
13using namespace dealii;
14
15/**
16 * @brief Find steps for dynamic contact search for particle-particle contacts.
17
18 * @tparam dim An integer that denotes the number of spatial dimensions.
19 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
20 * @param particle_handler
21 * @param dt DEM time step
22 * @param smallest_contact_search_criterion A criterion for finding
23 * dynamic contact search steps. This value is defined as the minimum of
24 * particle-particle and particle-wall displacement threshold values
25 * @param mpi_communicator
26 * @param displacement Displacement of particles since last sorting step
27 * @param parallel_update Update the identification of the contact detection
28 * step in parallel. If this parameter is set to false, the distance will be
29 * calculated but the
30 * logical OR statement won't be called and a false value will be returned. In
31 * essence, this will only update the displacement.
32 *
33 * @return Returns true if the maximum cumulative displacement of particles
34 * exceeds the threshold and false otherwise
35
36 */
37template <int dim, typename PropertiesIndex>
38void
40 Particles::ParticleHandler<dim> &particle_handler,
41 const double dt,
42 const double smallest_contact_search_criterion,
43 MPI_Comm &mpi_communicator,
44 std::vector<double> &displacement,
45 const bool parallel_update = true);
46
47/**
48 * @brief Find steps for dynamic contact search in particle-floating
49 * mesh contacts
50 *
51 * @param smallest_contact_search_criterion A criterion which defines the maximal displacement that a solid face may have displaced
52 * @param solids All solid objects used in the simulation
53 * @return Returns true if the maximum cumulative
54 * displacement of particles exceeds the threshold and false otherwise
55 */
56template <int dim>
57void
59 const double smallest_contact_search_criterion,
60 std::vector<std::shared_ptr<SerialSolid<dim - 1, dim>>> solids);
61
62#endif
void find_particle_contact_detection_step(Particles::ParticleHandler< dim > &particle_handler, const double dt, const double smallest_contact_search_criterion, MPI_Comm &mpi_communicator, std::vector< double > &displacement, const bool parallel_update=true)
Find steps for dynamic contact search for particle-particle contacts.
void find_floating_mesh_mapping_step(const double smallest_contact_search_criterion, std::vector< std::shared_ptr< SerialSolid< dim - 1, dim > > > solids)
Find steps for dynamic contact search in particle-floating mesh contacts.