RAParticleInletPropertiesList#

class ansys.rocky.app.ra_particle_inlet_properties.RAParticleInletPropertiesList(id: str, model_id: str | None = None)#

Bases: ansys.rocky.app.ra_list.RAList

Rocky PrePost Scripting wrapper for the input entries list in a single Particle Input.

To get the RAParticleInletPropertiesList from a RAParticleInlet, use:

input_properties_list = particle_input.GetInputPropertiesList()

RAParticleInletPropertiesList contains methods to add, remove and retrieve individual input property entries. It corresponds to the list of entries on a Particle Input’s “Input” tab on the Rocky UI.

The following examples add, remove and access individual entries in the input properties list:

# Add new items
input_properties_1 = input_properties_list.New()

# Access and modify items
input_properties_2 = input_properties_list[0]
input_properties_2.SetParticle('Particle 1')

# Remove items
input_properties_list.Remove(input_properties_2)
del input_properties_list[0]
input_properties_list.Clear()

The RAParticleInletPropertiesList is a list of RAParticleInletProperties.

Overview#

Import detail#

from ansys.rocky.app.ra_particle_inlet_properties import RAParticleInletPropertiesList

Method detail#

classmethod RAParticleInletPropertiesList.GetWrappedClass()#
classmethod RAParticleInletPropertiesList.GetClassName() str#