RAUserProcess#

class ansys.rocky.app.ra_process_element.RAUserProcess#

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem

Base class for UserProcesses

Overview#

GetNumberOfParticles

Get the total number of particles in this selection. Only for processes created on Particles.

IterParticles

Iterate on particles in this selection at the given time. Only for processes created on Particles.

Import detail#

from ansys.rocky.app.ra_process_element import RAUserProcess

Method detail#

RAUserProcess.GetNumberOfParticles(time_step)#

Get the total number of particles in this selection. Only for processes created on Particles.

Parameters:

time_step (unicode, ITimeStep or int) – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set

Return type:

int

Returns:

The number of particles

RAUserProcess.IterParticles(time_step)#

Iterate on particles in this selection at the given time. Only for processes created on Particles.

Parameters:

time_step (unicode, ITimeStep or int) – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set

Return type:

iterator(Particle)

Returns:

An iterator over the particles. A Particle has: - x, y, z, size - x_axis, y_axis, z_axis, orientation_angle - type, particle_group