This method searches for a point cloud dataset in the project, by name.

Parameters

name	The name given to the point cloud in the Rocky UI.

Returns

The index that uniquely identifies the wanted point cloud, if it was actually found. It returns -1 otherwise.

This method searches for a specific property name in a point cloud dataset

imported into Rocky.

Parameters

point_cloud_index	The index that uniquely identifies the point cloud.
property_name	The name given to the property in the file defining the point cloud.

Returns

The index that uniquely identifies the wanted point cloud property, if it was actually found. It returns -1 otherwise.

Returns

An IRockyContactDataRecorder object which allows a module to configure which physical magnitudes the internal contact data recorder will record for use in statistics processing later on.

Returns

The value of the current simulation time.

Returns

An IRockyCurveCollectionData object which allows to create and manage custom time curves and/or custom cross-plot curves that can be displayed in the Rocky UI.

Returns

The index that identifies a given device when running a simulation in multi-GPU.

Returns

The energy factor in Joule, used to nondimensionalize energy parameters.

Returns

The force factor in Newton, used to nondimensionalize force parameters.

Returns

The name given in the Rocky UI the geometry identified by geometry_index.

Returns

An IRockyGeometryScalarsModel object, which allows users to add new boundary scalars during a setup of a module. Boundary scalars are special variables that associate values to all geometries within a project.

Returns

An enum key indicating the type of a geometry contained in a project. The possible values are:
btReceivingConveyor = 1
btFeedConveyor = 2
btCustom = 3
btInlet = 4

Parameters

geometry_index

The index that identifies a geometry within the Rocky solver.

Returns

An IRockyInteractionCalculationsData object, which can be used to access data and methods related to materials, materials interactions and particle groups.

Returns

An IRockyJointScalarsModel object, which allows users to add new joint scalars during a setup of a module. Joint scalars are special variables attached to joints in flexible particles that are able to store values that are preserved between time iterations.

Returns

The length factor in meters, used to nondimensionalize length parameters.

Returns

The length factor in kilograms, used to nondimensionalize mass parameters.

Returns

The current number of active particles in the simulation. This number can vary throughout a simulation because new particles are injected and/or some particles leave the solution domain.

Returns

The current number of active triangles in the simulation. This number can vary throughout a simulation because the active particle region changes due to particles moving, which will active or de-active triangles that are inside or outside the active region.

Returns

The number of devices set to run the simulation when using multi-GPU.

Returns

The total number of boundaries defined in the Rocky project.

Returns

The total number of material interactions that it is possible to define with the current materials defined in the Rocky project.

Returns

The total number of materials defined in the Rocky project.

Returns

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

Returns

The total number of individual particles in a whole simulation.

Returns

The number of allowed parallel processes when the simulation runs in CPU.

Returns

The value of the simulation output interval.

Returns

An IRockyPairScalarsModel object, which allows users to add new pair scalars during a setup of a module. Pair scalars are special variables that associate values to all combinations of particle groups and combinations of particle groups and geometries within a project.

Returns

An IRockyParticleBreakageScalarsModel object, which allows users to add new particle breakage scalars or activate particle breakage scalars known to Rocky during the setup of a module. Particle breakage scalars are special particle scalars used in conjunction with instantaneous breakage models, in order to transfer values calculated at a breakage event to the point at which the fragments size distribution is determined.

Returns

An IRockyContactScalarsModel object, which allows users to add new (particle-to-particle) contact scalars during the setup phase of a module. Contact scalars are special variables attached to contacts that are able to store values that are preserved between time iterations.
For handling scalars related to particle-to-triangle contacts, please consult the
IRockyModel::get_triangle_contact_scalars method.

Returns

The name given in the Rocky UI the particle group identified by particle_group_index.

Returns

An IRockyParticleScalarsModel object, which allows users to add new particle scalars or activate particle scalars known to Rocky during the setup of a module. Particle scalars are special variables attached to particles that are able to store values per particle that are preserved between time iterations.

Returns

An IRockyParticleTransferScalarsModel object, which allows users to add new particle transfer scalars or activate particle transfer scalars known to Rocky during the setup of a module. Particle transfer scalars are special particle scalars whose values are reset automatically to zero at the beginning of a new time iteration. Their typical use is the accumulation of values from all contacts or joints associated to a particle or an element at a given time iteration.

Returns

The pressure factor in Pascal, used to nondimensionalize pressure parameters.

Returns

The value of the numerical softening factor, which is a global reduction factor that multiplies all stiffness values computed throughout a simulation. This factor is commonly used to increase the timestep and, therefore, speed up the execution of simulations.

Returns

The temperature factor in Kelvin, used to nondimensionalize temperature parameters.

Returns

The time factor in seconds, used to nondimensionalize time parameters.

Returns

The current value of the simulation timestep.

Returns

An IRockyContactScalarsModel object, which allows users to add new (particle-to-triangle) contact scalars during the setup phase of a module. Contact scalars are special variables attached to contacts that are able to store values that are preserved between time iterations.
For handling scalars for particle-to-particle contacts, please consult the
IRockyModel::get_particle_contact_scalars method.

Returns

An IRockyTriangleScalarsModel object, which allows users to add new triangle scalars during a setup of a module. Triangle scalars are special variables attached to geometry triangles that are able to store values that are preserved between time iterations.

Returns

True if the current Rocky project has enabled some adhesion model. Adhesive contacts will exist in a simulation only if that condition is met.

Returns

True if the thermal option is enabled in the current Rocky project, false otherwise.

This method sets a value of the adhesive distance per material interaction,

for a custom adhesive force model. Whenever a new value set for an adhesive distance is greater than the previous maximum adhesive distance among all material interactions, a new neighbors search operation will be triggered. For this reason, if adhesive distances are increased too frequently, the simulation performance can be compromised.

Parameters

home_index	The index of the first material in the material interaction.
near_index	The index of the second material in the material interaction.
adhesive_distance	The value of the adhesive distance for contacts involving entities with the specified combination of materials.

This method is intended to be used by a module implementing a variable restitution

coefficient model. It allows the module to set the minimum expected value of the restitution coefficient associated to a given material interaction. The Rocky solver will use these values to calculate the stable timestep for the simulation. Every time the value of the minimum restitution coefficient of any material interaction is changed, a timestep calculation will be triggered. For this reason, if the restitution coefficient changes too frequently, the simulation performance can be compromised. The timestep will be changed only if the new calculated timestep is smaller than the previous one.

Parameters

home_index	The index of the first material in the material interaction.
near_index	The index of the second material in the material interaction.
minimum_restitution	The minimum expected value for the restitution coefficient in a collision involving entities with the specified combination of materials.

The purpose of this method is to associate a dimensional factor

to a point cloud property. This factor will be used to nondimensionalize all the associated values. For instance, if the property represents a force, a force dimensional factor must be associated through this method. Dimensional factors for the fundamental magnitudes are provided by functions of an IRockyModel object.

Parameters

point_cloud_index	The index that uniquely identifies the point cloud.
property_index	The index that uniquely identifies the point cloud property.
dimension	The appropriate dimensional factor for the point cloud property.

When called, enable the timestep update calculation at the beginning of the next iteration. If the module implements the ROCKY_PLUGIN_COMPUTE_TIMESTEP method it will be called during the update process, changing the solver timestep if the new computed timestep is smaller than the current one.

Attention

If timestep is set using the advanced parameters, the update timestep calculation will be ignored.