RAParticles

class ansys.rocky.app.ra_particles_process.RAParticles

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem

Rocky api Particles model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetNumberOfParticles	Get the number of active particles at the given time step.
IterParticles	Iterate on the active particles at the given time step.
RemoveProcess	It is not possible to remove the item “Particles” from the project. It’s a standard Rocky

Import detail

from ansys.rocky.app.ra_particles_process import RAParticles

Method detail

classmethod RAParticles.GetWrappedClass()

classmethod RAParticles.GetClassName()

RAParticles.GetNumberOfParticles(time_step)

Get the number of active particles at the given time step.

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

RAParticles.IterParticles(time_step)

Iterate on the active particles at the given time step.

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

RAParticles.RemoveProcess() → None

It is not possible to remove the item “Particles” from the project. It’s a standard Rocky item in project.