RAParticleInlet

class ansys.rocky.app.ra_particle_inlet.RAParticleInlet(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper for a single Continuous Injection input.

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

input_1 = study.GetElement('Continuous Injection <1>')
input_2 = input_collection.GetParticleInput('Continuous Injection <2>')

Instances of RAParticleInlet comprise two parts: Properties that can be manipulated directly, such as the input’s name and the particle entry point, and the input properties list that describe which particles enter via this input and with each mass flow rate, temperature, etc. This list must be manipulated via the RAParticleInputPropertiesList returned by GetInputPropertiesList().

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetInputPropertiesList	Return a list of input properties
AddParticle	Add a new particle to the Particle Inlet input properties list.
RemoveParticle	Remove a particle from the Particle Inlet input properties list.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetInjectionDuration	Get the value of “Injection Duration”.
SetInjectionDuration	Set the value of “Injection Duration”.
GetForcePacking	Get the value of “Force Packing”.
SetForcePacking	Set the value of “Force Packing”.
EnableForcePacking	Set the value of “Force Packing” to True.
DisableForcePacking	Set the value of “Force Packing” to False.
IsForcePackingEnabled	Check if the “Force Packing” is enabled.
GetPeriod	Get the value of “Period”.
SetPeriod	Set the value of “Period”.
GetPeriodic	Get the value of “Periodic”.
SetPeriodic	Set the value of “Periodic”.
EnablePeriodic	Set the value of “Periodic” to True.
DisablePeriodic	Set the value of “Periodic” to False.
IsPeriodicEnabled	Check if the “Periodic” is enabled.
GetStartTime	Get the value of “Start Time”.
SetStartTime	Set the value of “Start Time”.
GetStopAllAtStopTime	Get the value of “Stop All At Stop Time”.
SetStopAllAtStopTime	Set the value of “Stop All At Stop Time”.
EnableStopAllAtStopTime	Set the value of “Stop All At Stop Time” to True.
DisableStopAllAtStopTime	Set the value of “Stop All At Stop Time” to False.
IsStopAllAtStopTimeEnabled	Check if the “Stop All At Stop Time” is enabled.
GetStopTime	Get the value of “Stop Time”.
SetStopTime	Set the value of “Stop Time”.
GetTargetNormalVelocity	Get the value of “Target Normal Velocity”.
SetTargetNormalVelocity	Set the value of “Target Normal Velocity”.
GetUseTargetNormalVelocity	Get the value of “Use Target Normal Velocity”.
SetUseTargetNormalVelocity	Set the value of “Use Target Normal Velocity”.
EnableUseTargetNormalVelocity	Set the value of “Use Target Normal Velocity” to True.
DisableUseTargetNormalVelocity	Set the value of “Use Target Normal Velocity” to False.
IsUseTargetNormalVelocityEnabled	Check if the “Use Target Normal Velocity” is enabled.
GetUxLocal	Get the value of “Ux Local”.
SetUxLocal	Set the value of “Ux Local”.
GetUzLocal	Get the value of “Uz Local”.
SetUzLocal	Set the value of “Uz Local”.
GetSphInjectionEnabled	Get the value of “Sph Injection Enabled”.
SetSphInjectionEnabled	Set the value of “Sph Injection Enabled”.
GetSphTemperature	Get the value of “Sph Temperature”.
SetSphTemperature	Set the value of “Sph Temperature”.
GetEntryPoint	Get the “Entry Point”.
SetEntryPoint	Set the “Entry Point”.
GetAvailableEntryPoints	Get all available Entry Points.

Import detail

from ansys.rocky.app.ra_particle_inlet import RAParticleInlet

Method detail

classmethod RAParticleInlet.GetWrappedClass()

classmethod RAParticleInlet.GetClassName() → str

RAParticleInlet.GetInputPropertiesList() → ansys.rocky.app.ra_particle_inlet_properties.RAParticleInletPropertiesList

Return a list of input properties

RAParticleInlet.AddParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) → ansys.rocky.app.ra_particle_inlet_properties.RAParticleInletPropertiesList

Add a new particle to the Particle Inlet input properties list.

: return: A new RAParticleInletPropertiesList object that can be used to set

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

Remove a particle from the Particle Inlet input properties list.

Parameters:

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

RAParticleInlet.GetName() → str

Get the value of “Name”.

RAParticleInlet.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAParticleInlet.GetInjectionDuration(unit: str | None = None) → float

Get the value of “Injection Duration”.

Parameters:

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

RAParticleInlet.SetInjectionDuration(value: str | float, unit: str | None = None) → None

Set the value of “Injection Duration”.

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

RAParticleInlet.GetForcePacking() → bool

Get the value of “Force Packing”.

RAParticleInlet.SetForcePacking(value: bool) → None

Set the value of “Force Packing”.

Parameters:

value – The value to set.

RAParticleInlet.EnableForcePacking() → None

Set the value of “Force Packing” to True.

RAParticleInlet.DisableForcePacking() → None

Set the value of “Force Packing” to False.

RAParticleInlet.IsForcePackingEnabled() → bool

Check if the “Force Packing” is enabled.

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

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

RAParticleInlet.GetPeriodic() → bool

Get the value of “Periodic”.

RAParticleInlet.SetPeriodic(value: bool) → None

Set the value of “Periodic”.

Parameters:

value – The value to set.

RAParticleInlet.EnablePeriodic() → None

Set the value of “Periodic” to True.

RAParticleInlet.DisablePeriodic() → None

Set the value of “Periodic” to False.

RAParticleInlet.IsPeriodicEnabled() → bool

Check if the “Periodic” is enabled.

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

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

RAParticleInlet.GetStopAllAtStopTime() → bool

Get the value of “Stop All At Stop Time”.

RAParticleInlet.SetStopAllAtStopTime(value: bool) → None

Set the value of “Stop All At Stop Time”.

Parameters:

value – The value to set.

RAParticleInlet.EnableStopAllAtStopTime() → None

Set the value of “Stop All At Stop Time” to True.

RAParticleInlet.DisableStopAllAtStopTime() → None

Set the value of “Stop All At Stop Time” to False.

RAParticleInlet.IsStopAllAtStopTimeEnabled() → bool

Check if the “Stop All At Stop Time” is enabled.

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

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

RAParticleInlet.GetTargetNormalVelocity(unit: str | None = None) → float

Get the value of “Target Normal Velocity”.

Parameters:

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

RAParticleInlet.SetTargetNormalVelocity(value: str | float, unit: str | None = None) → None

Set the value of “Target Normal 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”.

RAParticleInlet.GetUseTargetNormalVelocity() → bool

Get the value of “Use Target Normal Velocity”.

RAParticleInlet.SetUseTargetNormalVelocity(value: bool) → None

Set the value of “Use Target Normal Velocity”.

Parameters:

value – The value to set.

RAParticleInlet.EnableUseTargetNormalVelocity() → None

Set the value of “Use Target Normal Velocity” to True.

RAParticleInlet.DisableUseTargetNormalVelocity() → None

Set the value of “Use Target Normal Velocity” to False.

RAParticleInlet.IsUseTargetNormalVelocityEnabled() → bool

Check if the “Use Target Normal Velocity” is enabled.

RAParticleInlet.GetUxLocal(unit: str | None = None) → float

Get the value of “Ux Local”.

Parameters:

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

RAParticleInlet.SetUxLocal(value: str | float, unit: str | None = None) → None

Set the value of “Ux Local”.

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

RAParticleInlet.GetUzLocal(unit: str | None = None) → float

Get the value of “Uz Local”.

Parameters:

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

RAParticleInlet.SetUzLocal(value: str | float, unit: str | None = None) → None

Set the value of “Uz Local”.

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

RAParticleInlet.GetSphInjectionEnabled() → bool

Get the value of “Sph Injection Enabled”.

RAParticleInlet.SetSphInjectionEnabled(value: bool) → None

Set the value of “Sph Injection Enabled”.

Parameters:

value – The value to set.

RAParticleInlet.GetSphTemperature(unit: str | None = None) → float

Get the value of “Sph Temperature”.

Parameters:

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

RAParticleInlet.SetSphTemperature(value: str | float, unit: str | None = None) → None

Set the value of “Sph 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”.

RAParticleInlet.GetEntryPoint()

Get the “Entry Point”.

Return type:

RAInletGeometry, RAFeedConveyor, RARectangularSurface, RACircularSurface, RASurface

RAParticleInlet.SetEntryPoint(value) → None

Set the “Entry Point”.

:param unicode, RAInletGeometry, RAFeedConveyor, RARectangularSurface, RACircularSurface, RASurface value:

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

RAParticleInlet.GetAvailableEntryPoints()

Get all available Entry Points.

Return type:

List[RAInletGeometry, RAFeedConveyor, RARectangularSurface, RACircularSurface, RASurface] A list of RAInletGeometry, RAFeedConveyor, RARectangularSurface, RACircularSurface, RASurface.