Skip to main content

Rocky Solver SDK 2024 R2

IRockyAdhesiveDistanceData Class Reference

Last update: 08.07.2024

#include <rocky_timestep_api.h>

Inherits IRockyInteractionCalculationsData.

Public Member Functions

void set_adhesive_distance (int home_index, int near_index, double adhesive_distance)
 
- Public Member Functions inherited from IRockyInteractionCalculationsData
int get_number_particle_groups () const
 
int get_particle_material_index (int group_index) const
 
double get_particle_min_sieve_size (int group_index) const
 
double get_particle_max_sieve_size (int group_index) const
 
double get_particle_min_mass (int group_index) const
 
int get_number_geometry_materials () const
 
int get_geometry_material_index (int index) const
 
IRockyMaterial get_material (int index) const
 
int get_material_interaction_index (int home_index, int near_index) const
 
IRockyMaterialInteraction get_material_interaction (int home_index, int near_index) const
 

Detailed Description

An IRockyAdhesiveDistanceData object provides data and utility methods needed to estimate and set appropriate values of adhesive distance per material interaction. The adhesive distance defines the upper limit for the activation of an adhesive contact between two particles or between a particle and a geometry. An adhesive contact only can exist when the effective gap distance between two entities is below the adhesive distance value stipulated for the corresponding material interaction. Therefore, no adhesive forces will be computed if that effective gap distance is larger than the specified adhesive distance. If a custom module does not implement a special adhesive distance calculation, Rocky will set the adhesive distances of all material interactions to a fixed value equal to 1 mm.

The class IRockyAdhesiveDistanceData inherits all public methods of the class IRockyInteractionCalculationsData.

Member Function Documentation

◆ set_adhesive_distance()

void IRockyAdhesiveDistanceData::set_adhesive_distance ( int  home_index,
int  near_index,
double  adhesive_distance 
)
This method sets a value of the adhesive distance per material interaction,
for a custom adhesive force model.
Parameters
home_indexThe index of the first material.
near_indexThe index of the second material.
adhesive_distanceThe value of the adhesive distance just calculated.