RAMassFlowDynamicInlet

class ansys.rocky.app.ra_mass_flow_dynamic_inlet.RAMassFlowDynamicInlet(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper for a single Mass Flow Dynamic Inlet input.

This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s data tree. Mass Flow Dynamic Inlets can be retrieved from the RAStudy or the RAInletsOutletsCollection via:

inlet = study.GetElement('Mass Flow Dynamic Inlet <1>')

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetInputPropertiesList	Return a list of input properties
AddParticle	Add a new particle to the Mass Flow Dynamic Inlet input properties list.
RemoveParticle	Remove a particle from the Mass Flow Dynamic Inlet input properties list.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetInjectionVelocity	Get the value of “Injection Velocity”.
SetInjectionVelocity	Set the value of “Injection Velocity”.
GetMaximumInjectionTries	Get the value of “Maximum Injection Tries”.
SetMaximumInjectionTries	Set the value of “Maximum Injection Tries”.
GetPeriod	Get the value of “Period”.
SetPeriod	Set the value of “Period”.
GetRandomTravelExponent	Get the value of “Random Travel Exponent”.
SetRandomTravelExponent	Set the value of “Random Travel Exponent”.
GetSizeScaling	Get the value of “Size Scaling”.
SetSizeScaling	Set the value of “Size Scaling”.
GetStartTime	Get the value of “Start Time”.
SetStartTime	Set the value of “Start Time”.
GetStopTime	Get the value of “Stop Time”.
SetStopTime	Set the value of “Stop Time”.
GetVoidFraction	Get the value of “Void Fraction”.
SetVoidFraction	Set the value of “Void Fraction”.

Import detail

from ansys.rocky.app.ra_mass_flow_dynamic_inlet import RAMassFlowDynamicInlet

Method detail

classmethod RAMassFlowDynamicInlet.GetWrappedClass()

classmethod RAMassFlowDynamicInlet.GetClassName() → str

RAMassFlowDynamicInlet.GetInputPropertiesList() → ansys.rocky.app.ra_mass_flow_dynamic_inlet_properties.RAMassFlowDynamicInletPropertiesList

Return a list of input properties

RAMassFlowDynamicInlet.AddParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) → ansys.rocky.app.ra_mass_flow_dynamic_inlet_properties.RAMassFlowDynamicInletPropertiesList

Add a new particle to the Mass Flow Dynamic Inlet input properties list.

Returns:

A new RAMassFlowDynamicInletPropertiesList object.

RAMassFlowDynamicInlet.RemoveParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) → None

Remove a particle from the Mass Flow Dynamic Inlet input properties list.

Parameters:

particle – The particle to remove, either as an RAParticle object or by name.

RAMassFlowDynamicInlet.GetName() → str

Get the value of “Name”.

RAMassFlowDynamicInlet.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAMassFlowDynamicInlet.GetInjectionVelocity(unit: str | None = None) → float

Get the value of “Injection Velocity”.

Parameters:

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

RAMassFlowDynamicInlet.SetInjectionVelocity(value: str | float, unit: str | None = None) → None

Set the value of “Injection Velocity”.

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 “m/s”.

RAMassFlowDynamicInlet.GetMaximumInjectionTries() → int

Get the value of “Maximum Injection Tries”.

RAMassFlowDynamicInlet.SetMaximumInjectionTries(value: str | int) → None

Set the value of “Maximum Injection Tries”.

Parameters:

value – The value to set. This value can be an expression with input variables or int type.

RAMassFlowDynamicInlet.GetPeriod(unit: str | None = None) → float

Get the value of “Period”.

Parameters:

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

RAMassFlowDynamicInlet.SetPeriod(value: str | float, unit: str | None = None) → None

Set the value of “Period”.

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

RAMassFlowDynamicInlet.GetRandomTravelExponent() → float

Get the value of “Random Travel Exponent”.

RAMassFlowDynamicInlet.SetRandomTravelExponent(value: str | float) → None

Set the value of “Random Travel Exponent”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RAMassFlowDynamicInlet.GetSizeScaling() → float

Get the value of “Size Scaling”.

RAMassFlowDynamicInlet.SetSizeScaling(value: str | float) → None

Set the value of “Size Scaling”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RAMassFlowDynamicInlet.GetStartTime(unit: str | None = None) → float

Get the value of “Start Time”.

Parameters:

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

RAMassFlowDynamicInlet.SetStartTime(value: str | float, unit: str | None = None) → None

Set the value of “Start Time”.

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

RAMassFlowDynamicInlet.GetStopTime(unit: str | None = None) → float

Get the value of “Stop Time”.

Parameters:

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

RAMassFlowDynamicInlet.SetStopTime(value: str | float, unit: str | None = None) → None

Set the value of “Stop Time”.

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

RAMassFlowDynamicInlet.GetVoidFraction() → float

Get the value of “Void Fraction”.

RAMassFlowDynamicInlet.SetVoidFraction(value: str | float) → None

Set the value of “Void Fraction”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.