Skip to main content

Rocky Solver SDK 2024 R2

IRockyTimestepData Class Reference

Last update: 08.07.2024

#include <rocky_timestep_api.h>

Inherits IRockyInteractionCalculationsData.

Public Member Functions

int get_loading_n_steps () const
 
- 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 IRockyTimestepData object provides the data and methods needed to estimate a stable simulation timestep when a module implements a custom contact force model. The class IRockyTimestepData inherits all public methods of the class IRockyInteractionCalculationsData.

Member Function Documentation

◆ get_loading_n_steps()

int IRockyTimestepData::get_loading_n_steps ( ) const
Returns
The minimum number of timesteps that the loading period of the shortest collision in a simulation can have. This is a parameter whose value is specified through the Rocky UI.