RAParticleInletProperties#

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

Bases: ansys.rocky.app.api_element_item.ApiElementItem, ansys.rocky.app.ra_addins.ElementWithAddins

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')

Overview#

GetWrappedClass

GetClassName

GetMassFlowRate

Get the value of “Mass Flow Rate”.

SetMassFlowRate

Set the value of “Mass Flow Rate”.

GetTemperature

Get the value of “Temperature”.

SetTemperature

Set the value of “Temperature”.

GetParticle

Get the “Particle”.

SetParticle

Set the “Particle”.

GetAvailableParticles

Get all available Particles.

Import detail#

from ansys.rocky.app.ra_particle_inlet_properties import RAParticleInletProperties

Method detail#

classmethod RAParticleInletProperties.GetWrappedClass() → type[rocky30.models.input.particle_inlet.ParticleInletProperties]#
classmethod RAParticleInletProperties.GetClassName() → str#
RAParticleInletProperties.GetMassFlowRate(unit: str | None = None) → float#

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”.

RAParticleInletProperties.SetMassFlowRate(value: str | float, unit: str | None = 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”.

RAParticleInletProperties.GetTemperature(unit: str | None = None) → float#

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”.

RAParticleInletProperties.SetTemperature(value: str | float, unit: str | None = 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”.

RAParticleInletProperties.GetParticle()#

Get the “Particle”.

Return type:

RAParticle

RAParticleInletProperties.SetParticle(value) → None#

Set the “Particle”.

:param unicode, RAParticle value:

Either the API object wrapping the desired entity or its name.

RAParticleInletProperties.GetAvailableParticles()#

Get all available Particles.

Return type:

List[RAParticle] A list of RAParticle.