RAVolumetricInletProperties

class ansys.rocky.app.ra_volumetric_inlet_properties.RAVolumetricInletProperties(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 Volume Fill’s input list.

Access this wrapper from a given RAVolumetricInlet with:

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

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetMass	Get the value of “Mass”.
SetMass	Set the value of “Mass”.
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_volumetric_inlet_properties import RAVolumetricInletProperties

Method detail

classmethod RAVolumetricInletProperties.GetWrappedClass() → type[rocky30.models.input.volume_fill.VolumeFillProperties]

classmethod RAVolumetricInletProperties.GetClassName() → str

RAVolumetricInletProperties.GetMass(unit: str | None = None) → float

Get the value of “Mass”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “kg”.

RAVolumetricInletProperties.SetMass(value: str | float, unit: str | None = None) → None

Set the value of “Mass”.

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

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

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

RAVolumetricInletProperties.GetParticle()

Get the “Particle”.

Return type:

RAParticle

RAVolumetricInletProperties.SetParticle(value) → None

Set the “Particle”.

:param unicode, RAParticle value:

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

RAVolumetricInletProperties.GetAvailableParticles()

Get all available Particles.

Return type:

List[RAParticle] A list of RAParticle.