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

#include <particle_wall_contact_force.h>

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

Public Member Functions

virtual void calculate_particle_wall_contact (typename DEM::dem_data_structures< dim >::particle_wall_in_contact &particle_wall_pairs_in_contact, const double dt, ParticleInteractionOutcomes< PropertiesIndex > &contact_outcome)=0
virtual void calculate_particle_solid_object_contact (typename DEM::dem_data_structures< dim >::particle_floating_mesh_potentially_in_contact &particle_floating_mesh_potentially_in_contact, const double dt, const std::vector< std::shared_ptr< SerialSolid< dim - 1, dim > > > &solids, ParticleInteractionOutcomes< PropertiesIndex > &contact_outcome)=0
unsigned int get_number_of_contacts () const
void reset_number_of_contacts ()

Protected Attributes

unsigned int n_contacts = 0

Detailed Description

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

Base class for the particle-wall 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 implementation of the models are carried out in the ParticleWallContactForce 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 40 of file particle_wall_contact_force.h.

Member Function Documentation

◆ calculate_particle_solid_object_contact()

template<int dim, typename PropertiesIndex>
virtual void ParticleWallContactForceBase< dim, PropertiesIndex >::calculate_particle_solid_object_contact ( typename DEM::dem_data_structures< dim >::particle_floating_mesh_potentially_in_contact & particle_floating_mesh_potentially_in_contact,
const double dt,
const std::vector< std::shared_ptr< SerialSolid< dim - 1, dim > > > & solids,
ParticleInteractionOutcomes< PropertiesIndex > & contact_outcome )
pure virtual

Calculate the contact outcomes for particle-solid objects contacts using the contact pair information and physical properties.

Parameters
[in]particle_floating_mesh_potentially_in_contactA container that stores the information of particle-floating mesh contact.
[in]dtDEM time step.
[in]solidsFloating solids.
[out]contact_outcomeInteraction outcomes.

Implemented in ParticleWallContactForce< dim, PropertiesIndex, contact_model, rolling_friction_model >.

◆ calculate_particle_wall_contact()

template<int dim, typename PropertiesIndex>
virtual void ParticleWallContactForceBase< dim, PropertiesIndex >::calculate_particle_wall_contact ( typename DEM::dem_data_structures< dim >::particle_wall_in_contact & particle_wall_pairs_in_contact,
const double dt,
ParticleInteractionOutcomes< PropertiesIndex > & contact_outcome )
pure virtual

Calculate the contact outcomes for particle-wall contacts using the contact pair information and physical properties.

Parameters
[in]particle_wall_pairs_in_contactRequired information for the calculation of the particle-wall contact.
[in]dtDEM time step.
[out]contact_outcomeInteraction outcomes.

Implemented in ParticleWallContactForce< dim, PropertiesIndex, contact_model, rolling_friction_model >.

◆ get_number_of_contacts()

template<int dim, typename PropertiesIndex>
unsigned int ParticleWallContactForceBase< 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.

Definition at line 83 of file particle_wall_contact_force.h.

References n_contacts.

◆ reset_number_of_contacts()

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

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

Definition at line 92 of file particle_wall_contact_force.h.

References n_contacts.

Member Data Documentation

◆ n_contacts

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

Definition at line 98 of file particle_wall_contact_force.h.


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