IRockyInteractionCalculationsData Class Reference
Last update: 08.07.2024
IRockyInteractionCalculationsData Class Reference
#include <rocky_timestep_api.h>
Inherited by IRockyAdhesiveDistanceData, and IRockyTimestepData.
Public Member Functions | |
| 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
IRockyInteractionCalculationsData gives access to data and methods needed for calculations related to materials, material interactions and particle groups, during the setup phase of a module. IRockyInteractionCalculationsData is a non-instantiable class, only derived classes can be used through Rocky API.
Member Function Documentation
◆ get_geometry_material_index()
| int IRockyInteractionCalculationsData::get_geometry_material_index | ( | int | index | ) | const |
- Returns
- The internal index in Rocky that identifies a material.
- Parameters
-
index The index of a geometry material in a loop over all materials associated to geometries in a project.
◆ get_material()
| IRockyMaterial IRockyInteractionCalculationsData::get_material | ( | int | index | ) | const |
- Returns
- An
IRockyMaterialobject that gives access to the property values associated to a given material.
- Parameters
-
index The internal index in Rocky that identifies a material.
◆ get_material_interaction()
| IRockyMaterialInteraction IRockyInteractionCalculationsData::get_material_interaction | ( | int | home_index, |
| int | near_index | ||
| ) | const |
- Returns
- An
IRockyMaterialInteractionobject that gives access to the property values associated to a given material interaction.
- Parameters
-
home_index The index of the first material. near_index The index of the second material.
◆ get_material_interaction_index()
| int IRockyInteractionCalculationsData::get_material_interaction_index | ( | int | home_index, |
| int | near_index | ||
| ) | const |
- Returns
- The internal index in Rocky that identifies a material interaction.
- Parameters
-
home_index The index of the first material. near_index The index of the second material.
◆ get_number_geometry_materials()
| int IRockyInteractionCalculationsData::get_number_geometry_materials | ( | ) | const |
- Returns
- The total number of different materials associated to the geometries or boundaries in a project.
◆ get_number_particle_groups()
| int IRockyInteractionCalculationsData::get_number_particle_groups | ( | ) | const |
- Returns
- The total number of particle groups defined in the project. A particle group is a category of particles with the same shape and material.
◆ get_particle_material_index()
| int IRockyInteractionCalculationsData::get_particle_material_index | ( | int | group_index | ) | const |
- Returns
- The index that uniquely identifies internally in Rocky the material associated with a particle group.
- Parameters
-
group_index The index that identifies internally a particle group in Rocky.
◆ get_particle_max_sieve_size()
| double IRockyInteractionCalculationsData::get_particle_max_sieve_size | ( | int | group_index | ) | const |
- Returns
- The 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_index The index that identifies internally a particle group in Rocky.
◆ get_particle_min_mass()
| double IRockyInteractionCalculationsData::get_particle_min_mass | ( | int | group_index | ) | const |
- Returns
- The 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_index The index that identifies internally a particle group in Rocky.
◆ get_particle_min_sieve_size()
| double IRockyInteractionCalculationsData::get_particle_min_sieve_size | ( | int | group_index | ) | const |
- Returns
- The 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_index The index that identifies internally a particle group in Rocky.