Rocky PrePost scripting 2026 R1

RAParticleInletProperties

Last update: 23.02.2026

class RAParticleInletProperties

Rocky PrePost Scripting wrapper for a single entry in a single Particle Input’s input list.

Access this wrapper from a given RAParticleInlet with:

input_properties_list = particle_input.GetInputPropertiesList()
input_properties_1 = input_properties_list.New()
input_properties_1.SetParticle('Particle 1')
input_properties_1.SetMassFlowRate(100, 't/h')

Methods:

Name Description
GetAvailableParticles() Get all available Particles.
GetMassFlowRate([unit]) Get the value of "Mass Flow Rate".
GetModuleProperties() Get the names of the module properties.
GetModuleProperty(property_name[, unit]) Get the value of a module property.
GetParticle() Get the "Particle".
GetTemperature([unit]) Get the value of "Temperature".
GetValidOptionsForModuleProperty(property_name) Get all valid options only for properties that have a list of possible options.
SetMassFlowRate(value[, unit]) Set the value of "Mass Flow Rate".
SetModuleProperty(property_name, value[, unit]) Set the value of a module property.
SetParticle(value) Set the "Particle".
SetTemperature(value[, unit]) Set the value of "Temperature".

GetAvailableParticles()

Get all available Particles.

GetMassFlowRate(unit: str | None = None)

Get the value of “Mass Flow Rate”.

  • Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “t/h”.

GetModuleProperties()

Get the names of the module properties.

  • Return type: tuple(ModulePropertyIdentifier)

GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None)

Get the value of a module property.

  • Parameters:
    • property_name (Union *[*str , ModulePropertyIdentifier ]) – The name of the module property to get.
    • unit (str) – The unit for value, just for scalar properties. If no unit is provided, the returned value will be in the unit that was set before (via SetModuleProperty()).
  • Return type: float, bool, str or RAModulePropertyList
  • Returns:
    • For basic module properties like numbers and booleans, the returned value is a basic Python type (float, bool, or string)
    • For input files, the returned value is the string of the full path to the file
    • For properties that are lists of other properties, the returned value is a : RAModulePropertyList.

GetParticle()

Get the “Particle”.

GetTemperature(unit: str | None = None)

Get the value of “Temperature”.

  • Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “K”.

GetValidOptionsForModuleProperty(property_name)

Get all valid options only for properties that have a list of possible options.

  • Parameters: property_name (str) – The name of the module property.
  • Return type: List[str]

SetMassFlowRate(value: str | float, unit: str | None = None)

Set the value of “Mass Flow Rate”.

  • Parameters:
    • value – The value to set. This value can be an expression with input variables or float type.
    • unit – The unit for value. If no unit is provided, value is assumed to be in “t/h”.

SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None)

Set the value of a module property.

  • Parameters:
    • property_name (Union *[*str , ModulePropertyIdentifier ]) – The name of the module property to set.
    • value (float , bool or str) – The value to set. If the property_name references to an enum property then value must be an str value.
    • unit (str) – The unit for value, just for scalar properties. If no unit is provided, value is assumed to be the unit was set before.

SetParticle(value)

Set the “Particle”.

:param unicode, RAParticle value: : Either the API object wrapping the desired entity or its name.

SetTemperature(value: str | float, unit: str | None = None)

Set the value of “Temperature”.

  • Parameters:
    • value – The value to set. This value can be an expression with input variables or float type.
    • unit – The unit for value. If no unit is provided, value is assumed to be in “K”.

Connect with Ansys