Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
set_particle_wall_contact_force_model.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 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_set_particle_wall_contact_force_model_h
5#define lethe_set_particle_wall_contact_force_model_h
6
9
10/**
11 * @brief Return the particle-wall contact force model based on the
12 * spring-dashpot model and the rolling resistance model (and the cohesive
13 * force model if applicable).
14 *
15 * @tparam dim An integer that denotes the number of spatial dimensions.
16 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
17 *
18 * @param[in] dem_parameters DEM parameters.
19 *
20 * @return Pointer to the particle-wall contact force object.
21 */
22template <int dim, typename PropertiesIndex>
23std::shared_ptr<ParticleWallContactForceBase<dim, PropertiesIndex>>
25 const DEMSolverParameters<dim> &dem_parameters);
26
27/**
28 * @brief Set the rolling resistance model for the particle-wall contact
29 * force model.
30 *
31 * @tparam dim An integer that denotes the number of spatial dimensions.
32 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
33 * @tparam particle_wall_contact_force_model Particle-wall contact force
34 * model.
35 *
36 * @param[in] dem_parameters DEM parameters.
37 * @param[out] particle_wall_contact_force_object Pointer to the particle-
38 * wall contact force object.
39 */
40template <int dim,
41 typename PropertiesIndex,
43 particle_wall_contact_force_model>
44void
46 const DEMSolverParameters<dim> &dem_parameters,
48 &particle_wall_contact_force_object);
49
50#endif
Handles all the parameters declared in the parameter handler file.
Base class for the particle-wall contact force models This class does not implement any of the models...
PropertiesIndex
Particle property indices for pure DEM simulations.
ParticleWallContactForceModel
Contact force model for particle-wall interactions.
std::shared_ptr< ParticleWallContactForceBase< dim, PropertiesIndex > > set_particle_wall_contact_force_model(const DEMSolverParameters< dim > &dem_parameters)
Return the particle-wall contact force model based on the spring-dashpot model and the rolling resist...
void set_rolling_resistance_model(const DEMSolverParameters< dim > &dem_parameters, std::shared_ptr< ParticleWallContactForceBase< dim, PropertiesIndex > > &particle_wall_contact_force_object)
Set the rolling resistance model for the particle-wall contact force model.