Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
ParticleParticleContactForceBase< dim, PropertiesIndex > Class Template Referenceabstract

#include <particle_particle_contact_force.h>

Inheritance diagram for ParticleParticleContactForceBase< dim, PropertiesIndex >:
[legend]

Public Member Functions

virtual void calculate_particle_particle_contact (typename DEM::dem_data_structures< dim >::adjacent_particle_pairs &local_adjacent_particles, typename DEM::dem_data_structures< dim >::adjacent_particle_pairs &ghost_adjacent_particles, typename DEM::dem_data_structures< dim >::periodic_adjacent_particle_pairs &local_local_periodic_adjacent_particles, typename DEM::dem_data_structures< dim >::periodic_adjacent_particle_pairs &local_ghost_periodic_adjacent_particles, typename DEM::dem_data_structures< dim >::periodic_adjacent_particle_pairs &ghost_local_periodic_adjacent_particles, const double dt, ParticleInteractionOutcomes< PropertiesIndex > &contact_outcome)=0
void set_periodic_offset (const Tensor< 1, dim > &offset, const types::boundary_id boundary_id)
unsigned int get_number_of_contacts () const
void reset_number_of_contacts ()

Protected Attributes

unsigned int n_contacts = 0
std::unordered_map< types::boundary_id, Tensor< 1, dim > > periodic_offsets

Detailed Description

template<int dim, typename PropertiesIndex>
class ParticleParticleContactForceBase< dim, PropertiesIndex >

Base class for the particle-particle contact force models This class does not implement any of the models but ensures that an interface without template specialization is available. All the actual implementations of the models are carried out in the ParticleParticleContactForce class, which is templated by the contact model type.

Template Parameters
dimAn integer that denotes the number of spatial dimensions.
PropertiesIndexIndex of the properties used within the ParticleHandler.

Definition at line 37 of file particle_particle_contact_force.h.

Member Function Documentation

◆ calculate_particle_particle_contact()

template<int dim, typename PropertiesIndex>
virtual void ParticleParticleContactForceBase< dim, PropertiesIndex >::calculate_particle_particle_contact ( typename DEM::dem_data_structures< dim >::adjacent_particle_pairs & local_adjacent_particles,
typename DEM::dem_data_structures< dim >::adjacent_particle_pairs & ghost_adjacent_particles,
typename DEM::dem_data_structures< dim >::periodic_adjacent_particle_pairs & local_local_periodic_adjacent_particles,
typename DEM::dem_data_structures< dim >::periodic_adjacent_particle_pairs & local_ghost_periodic_adjacent_particles,
typename DEM::dem_data_structures< dim >::periodic_adjacent_particle_pairs & ghost_local_periodic_adjacent_particles,
const double dt,
ParticleInteractionOutcomes< PropertiesIndex > & contact_outcome )
pure virtual

Calculate the contact outcomes using the contact pair information obtained in the fine search and physical properties of particles.

Parameters
local_adjacent_particlesContainer of the contact pair candidates information for calculation of the local particle-particle contact forces.
ghost_adjacent_particlesContainer of the contact pair candidates information for calculation of the local-ghost particle-particle contact forces.
local_local_periodic_adjacent_particlesContainer of the contact pair candidates information for calculation of the local periodic particle-particle contact forces.
local_ghost_periodic_adjacent_particlesContainer of the contact pair candidates information for calculation of the local-ghost periodic particle-particle contact forces.
ghost_local_periodic_adjacent_particlesContainer of the contact pair candidates information for calculation of the ghost-local periodic particle-particle contact forces.
dtDEM time step.
contact_outcomeInteraction outcomes.

Implemented in ParticleParticleContactForce< dim, PropertiesIndex, contact_model, rolling_friction_model >, and ParticleParticleContactForce< dim, PropertiesIndex, force_model, rolling_friction_model >.

◆ get_number_of_contacts()

template<int dim, typename PropertiesIndex>
unsigned int ParticleParticleContactForceBase< dim, PropertiesIndex >::get_number_of_contacts ( ) const
inline

Return the number of contacts that occurred in the present pseudo-time step when using the packed insertion method.

Returns
The number of contacts that occurred in the present pseudo-time step.

Definition at line 99 of file particle_particle_contact_force.h.

References n_contacts.

◆ reset_number_of_contacts()

template<int dim, typename PropertiesIndex>
void ParticleParticleContactForceBase< dim, PropertiesIndex >::reset_number_of_contacts ( )
inline

Reset the counter of number of contacts for the next pseudo-time step.

Definition at line 108 of file particle_particle_contact_force.h.

References n_contacts.

◆ set_periodic_offset()

template<int dim, typename PropertiesIndex>
void ParticleParticleContactForceBase< dim, PropertiesIndex >::set_periodic_offset ( const Tensor< 1, dim > & offset,
const types::boundary_id boundary_id )
inline

Set the distance between a principal periodic boundary pb0 (with mesh ID boundary_id) and its associated periodic boundary pb1 in the periodic_offsets map.

Parameters
[in]offsetDistance between the pair of periodic boundaries.
[in]boundary_idMesh ID of the principal periodic boundary of the pair.

Definition at line 86 of file particle_particle_contact_force.h.

References periodic_offsets.

Member Data Documentation

◆ n_contacts

template<int dim, typename PropertiesIndex>
unsigned int ParticleParticleContactForceBase< dim, PropertiesIndex >::n_contacts = 0
protected

Definition at line 115 of file particle_particle_contact_force.h.

◆ periodic_offsets

template<int dim, typename PropertiesIndex>
std::unordered_map<types::boundary_id, Tensor<1, dim> > ParticleParticleContactForceBase< dim, PropertiesIndex >::periodic_offsets
protected

Map storing offset distance between periodic boundaries, keyed by the boundary ID (pb0). It is calculated from the first pair of cells on periodic boundaries, so all pairs of cells on a given peridodic boundary are assumed to have the same offset.

Definition at line 123 of file particle_particle_contact_force.h.


The documentation for this class was generated from the following file: