## On this page

  

 

 # IRockyInteractionCalculationsData Class Reference

 Last update: 16.07.2025 

`#include <<a class="el" href="rocky__timestep__api_8h_source.xhtml">rocky_timestep_api.h</a>>`

Inherited by [IRockyAdhesiveDistanceData](classIRockyAdhesiveDistanceData.xhtml), and [IRockyTimestepData](classIRockyTimestepData.xhtml).

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

int [get\_number\_particle\_groups](#ab5fb8e3d498bfc78f116eec7b53b22b8) () const int [get\_particle\_material\_index](#a700a3993ce6c50786c1323e0b91a7c3a) (int group\_index) const double [get\_particle\_min\_sieve\_size](#a1ce09b00f677c903a2d25426f8447300) (int group\_index) const double [get\_particle\_max\_sieve\_size](#ac12016128279790932537b32c1c7410d) (int group\_index) const double [get\_particle\_min\_mass](#a641adbab81c6c430aa1b0eae6eff29f4) (int group\_index) const int [get\_number\_geometry\_materials](#a986da6321cca08d20d20dbd43962a74a) () const int [get\_geometry\_material\_index](#a05cb28a940233bc976b806a5893c639c) (int index) const [IRockyMaterial](structIRockyMaterial.xhtml) [get\_material](#a609eb08b9a568e07c35953bd616d9551) (int index) const int [get\_material\_interaction\_index](#a1cf7ad2b906aa2f033494b390522bbb3) (int home\_index, int near\_index) const [IRockyMaterialInteraction](structIRockyMaterialInteraction.xhtml) [get\_material\_interaction](#aeb94fd8ed1f75bd0523634285ad94e4d) (int home\_index, int near\_index) const <a id="details" name="details"></a>## Detailed Description

`<a class="el" href="classIRockyInteractionCalculationsData.xhtml">IRockyInteractionCalculationsData</a>` gives access to data and methods needed for calculations related to materials, material interactions and particle groups, during the setup phase of a module. `<a class="el" href="classIRockyInteractionCalculationsData.xhtml">IRockyInteractionCalculationsData</a>` is a non-instantiable class, only derived classes can be used through Rocky API.



## Member Function Documentation

<a id="a05cb28a940233bc976b806a5893c639c" name="a05cb28a940233bc976b806a5893c639c"></a>## [◆ ](#a05cb28a940233bc976b806a5893c639c)get\_geometry\_material\_index()

 int IRockyInteractionCalculationsData::get\_geometry\_material\_index  ( int *index*)  const

ReturnsThe internal index in Rocky that identifies a material.Parameters indexThe index of a geometry material in a loop over all materials associated to geometries in a project. 



<a id="a609eb08b9a568e07c35953bd616d9551" name="a609eb08b9a568e07c35953bd616d9551"></a>## [◆ ](#a609eb08b9a568e07c35953bd616d9551)get\_material()

 [IRockyMaterial](structIRockyMaterial.xhtml) IRockyInteractionCalculationsData::get\_material  ( int *index*)  const

ReturnsAn `<a class="el" href="structIRockyMaterial.xhtml">IRockyMaterial</a>` object that gives access to the property values associated to a given material.Parameters indexThe internal index in Rocky that identifies a material. 



<a id="aeb94fd8ed1f75bd0523634285ad94e4d" name="aeb94fd8ed1f75bd0523634285ad94e4d"></a>## [◆ ](#aeb94fd8ed1f75bd0523634285ad94e4d)get\_material\_interaction()

 [IRockyMaterialInteraction](structIRockyMaterialInteraction.xhtml) IRockyInteractionCalculationsData::get\_material\_interaction  ( int *home\_index*,    int *near\_index* ) const

ReturnsAn `<a class="el" href="structIRockyMaterialInteraction.xhtml">IRockyMaterialInteraction</a>` object that gives access to the property values associated to a given material interaction.Parameters home\_indexThe index of the first material.near\_indexThe index of the second material. 



<a id="a1cf7ad2b906aa2f033494b390522bbb3" name="a1cf7ad2b906aa2f033494b390522bbb3"></a>## [◆ ](#a1cf7ad2b906aa2f033494b390522bbb3)get\_material\_interaction\_index()

 int IRockyInteractionCalculationsData::get\_material\_interaction\_index  ( int *home\_index*,    int *near\_index* ) const

ReturnsThe internal index in Rocky that identifies a material interaction.Parameters home\_indexThe index of the first material.near\_indexThe index of the second material. 



<a id="a986da6321cca08d20d20dbd43962a74a" name="a986da6321cca08d20d20dbd43962a74a"></a>## [◆ ](#a986da6321cca08d20d20dbd43962a74a)get\_number\_geometry\_materials()

 int IRockyInteractionCalculationsData::get\_number\_geometry\_materials  ( )  const

ReturnsThe total number of different materials associated to the geometries or boundaries in a project. 



<a id="ab5fb8e3d498bfc78f116eec7b53b22b8" name="ab5fb8e3d498bfc78f116eec7b53b22b8"></a>## [◆ ](#ab5fb8e3d498bfc78f116eec7b53b22b8)get\_number\_particle\_groups()

 int IRockyInteractionCalculationsData::get\_number\_particle\_groups  ( )  const

ReturnsThe total number of particle groups defined in the project. A particle group is a category of particles with the same shape and material. 



<a id="a700a3993ce6c50786c1323e0b91a7c3a" name="a700a3993ce6c50786c1323e0b91a7c3a"></a>## [◆ ](#a700a3993ce6c50786c1323e0b91a7c3a)get\_particle\_material\_index()

 int IRockyInteractionCalculationsData::get\_particle\_material\_index  ( int *group\_index*)  const

ReturnsThe index that uniquely identifies internally in Rocky the material associated with a particle group.Parameters group\_indexThe index that identifies internally a particle group in Rocky. 



<a id="ac12016128279790932537b32c1c7410d" name="ac12016128279790932537b32c1c7410d"></a>## [◆ ](#ac12016128279790932537b32c1c7410d)get\_particle\_max\_sieve\_size()

 double IRockyInteractionCalculationsData::get\_particle\_max\_sieve\_size  ( int *group\_index*)  const

ReturnsThe sieve size of the largest particle in a particle group. Zero is returned if no particles belonging to the particle group are actually injected into the simulation.Parameters group\_indexThe index that identifies internally a particle group in Rocky. 



<a id="a641adbab81c6c430aa1b0eae6eff29f4" name="a641adbab81c6c430aa1b0eae6eff29f4"></a>## [◆ ](#a641adbab81c6c430aa1b0eae6eff29f4)get\_particle\_min\_mass()

 double IRockyInteractionCalculationsData::get\_particle\_min\_mass  ( int *group\_index*)  const

ReturnsThe mass of the smallest particle in a particle group. Zero is returned if no particles belonging to the particle group are actually injected into the simulation.Parameters group\_indexThe index that identifies internally a particle group in Rocky. 



<a id="a1ce09b00f677c903a2d25426f8447300" name="a1ce09b00f677c903a2d25426f8447300"></a>## [◆ ](#a1ce09b00f677c903a2d25426f8447300)get\_particle\_min\_sieve\_size()

 double IRockyInteractionCalculationsData::get\_particle\_min\_sieve\_size  ( int *group\_index*)  const

ReturnsThe sieve size of the smallest particle in a particle group. Zero is returned if no particles belonging to the particle group are actually injected into the simulation.Parameters group\_indexThe index that identifies internally a particle group in Rocky.