Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
set_particle_particle_contact_force_model.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 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_set_particle_particle_contact_force_model_h
5#define lethe_set_particle_particle_contact_force_model_h
6
10
11
12/**
13 * @brief Return the particle-particle contact force model based on the
14 * spring-dashpot model and the rolling resistance model (and the cohesive
15 * force model if applicable).
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[in] dem_parameters DEM parameters.
21 *
22 * @return The pointer to the particle-particle contact force object.
23 */
24template <int dim, typename PropertiesIndex>
25std::shared_ptr<ParticleParticleContactForceBase<dim, PropertiesIndex>>
27 const DEMSolverParameters<dim> &dem_parameters);
28
29/**
30 * @brief Set the rolling resistance model for the particle-particle contact
31 * force model.
32 *
33 * @tparam dim An integer that denotes the number of spatial dimensions.
34 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
35 * @tparam particle_particle_contact_force_model Particle-particle contact force
36 * model.
37 *
38 * @param[in] dem_parameters DEM parameters.
39 * @param[out] particle_particle_contact_force_object Pointer to the particle-
40 * particle contact force object.
41 */
42template <int dim,
43 typename PropertiesIndex,
45 particle_particle_contact_force_model>
46void
48 const DEMSolverParameters<dim> &dem_parameters,
50 &particle_particle_contact_force_object);
51
52/**
53 * @brief Return the particle-particle contact force model based on the
54 * spring-dashpot model and the rolling resistance model (and the cohesive
55 * force model if applicable) for the force-chain post-processing.
56 *
57 * @tparam dim An integer that denotes the number of spatial dimensions.
58 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
59 *
60 * @param dem_parameters DEM parameters.
61 *
62 * @return The pointer to the particle-particle contact force object.
63 */
64template <int dim, typename PropertiesIndex>
65std::shared_ptr<ParticlesForceChainsBase<dim, PropertiesIndex>>
67 const DEMSolverParameters<dim> &dem_parameters);
68
69#endif
Handles all the parameters declared in the parameter handler file.
Base class for the particle-particle contact force models This class does not implement any of the mo...
PropertiesIndex
Particle property indices for pure DEM simulations.
ParticleParticleContactForceModel
Contact force model for particle-particle interactions.
std::shared_ptr< ParticleParticleContactForceBase< dim, PropertiesIndex > > set_particle_particle_contact_force_model(const DEMSolverParameters< dim > &dem_parameters)
Return the particle-particle contact force model based on the spring-dashpot model and the rolling re...
void set_rolling_resistance_model(const DEMSolverParameters< dim > &dem_parameters, std::shared_ptr< ParticleParticleContactForceBase< dim, PropertiesIndex > > &particle_particle_contact_force_object)
Set the rolling resistance model for the particle-particle contact force model.
std::shared_ptr< ParticlesForceChainsBase< dim, PropertiesIndex > > set_force_chains_contact_force_model(const DEMSolverParameters< dim > &dem_parameters)
Return the particle-particle contact force model based on the spring-dashpot model and the rolling re...