RAParticleInlet

class RAParticleInlet

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&gt;')
input_2 = input_collection.GetParticleInput('Continuous Injection 2&gt;')

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().

Methods:

Name	Description
`DisableForcePacking`()	Set the value of "Force Packing" to False.
`DisablePeriodic`()	Set the value of "Periodic" to False.
`DisablePeriodicDischarge`()	Deprecated: Use `DisablePeriodic()` instead.
`DisableStopAllAtStopTime`()	Set the value of "Stop All At Stop Time" to False.
`DisableUseTargetNormalVelocity`()	Set the value of "Use Target Normal Velocity" to False.
`EnableForcePacking`()	Set the value of "Force Packing" to True.
`EnablePeriodic`()	Set the value of "Periodic" to True.
`EnablePeriodicDischarge`()	Deprecated: Use `EnablePeriodic()` instead.
`EnableStopAllAtStopTime`()	Set the value of "Stop All At Stop Time" to True.
`EnableUseTargetNormalVelocity`()	Set the value of "Use Target Normal Velocity" to True.
`GetAvailableEntryPoints`()	Get all available Entry Points.
`GetDischargeTime`([unit])	Deprecated: Use `GetInjectionDuration()` instead.
`GetEntryPoint`()	Get the "Entry Point".
`GetForcePacking`()	Get the value of "Force Packing".
`GetInjectionDuration`([unit])	Get the value of "Injection Duration".
`GetInputPropertiesList`()	Return a list of input properties
`GetPeriod`([unit])	Get the value of "Period".
`GetPeriodic`()	Get the value of "Periodic".
`GetPeriodicDischarge`()	Deprecated: Use `GetPeriodic()` instead.
`GetSphInjectionEnabled`()	Get the value of "Sph Injection Enabled".
`GetSphTemperature`([unit])	Get the value of "Sph Temperature".
`GetStartTime`([unit])	Get the value of "Start Time".
`GetStopAllAtStopTime`()	Get the value of "Stop All At Stop Time".
`GetStopTime`([unit])	Get the value of "Stop Time".
`GetTargetNormalVelocity`([unit])	Get the value of "Target Normal Velocity".
`GetTonnageList`()	Deprecated: Use `GetInputPropertiesList()` instead.
`GetUseTargetNormalVelocity`()	Get the value of "Use Target Normal Velocity".
`GetUxLocal`([unit])	Get the value of "Ux Local".
`GetUzLocal`([unit])	Get the value of "Uz Local".
`IsForcePackingEnabled`()	Check if the "Force Packing" is enabled.
`IsPeriodicDischargeEnabled`()	Deprecated: Use `IsPeriodicEnabled()` instead.
`IsPeriodicEnabled`()	Check if the "Periodic" is enabled.
`IsStopAllAtStopTimeEnabled`()	Check if the "Stop All At Stop Time" is enabled.
`IsUseTargetNormalVelocityEnabled`()	Check if the "Use Target Normal Velocity" is enabled.
`SetDischargeTime`(value[, unit])	Deprecated: Use `SetInjectionDuration()` instead.
`SetEntryPoint`(value)	Set the "Entry Point".
`SetForcePacking`(value)	Set the value of "Force Packing".
`SetInjectionDuration`(value[, unit])	Set the value of "Injection Duration".
`SetPeriod`(value[, unit])	Set the value of "Period".
`SetPeriodic`(value)	Set the value of "Periodic".
`SetPeriodicDischarge`(value)	Deprecated: Use `SetPeriodic()` instead.
`SetSphInjectionEnabled`(value)	Set the value of "Sph Injection Enabled".
`SetSphTemperature`(value[, unit])	Set the value of "Sph Temperature".
`SetStartTime`(value[, unit])	Set the value of "Start Time".
`SetStopAllAtStopTime`(value)	Set the value of "Stop All At Stop Time".
`SetStopTime`(value[, unit])	Set the value of "Stop Time".
`SetTargetNormalVelocity`(value[, unit])	Set the value of "Target Normal Velocity".
`SetUseTargetNormalVelocity`(value)	Set the value of "Use Target Normal Velocity".
`SetUxLocal`(value[, unit])	Set the value of "Ux Local".
`SetUzLocal`(value[, unit])	Set the value of "Uz Local".

DisableForcePacking()

Set the value of “Force Packing” to False.

DisablePeriodic()

Set the value of “Periodic” to False.

DisablePeriodicDischarge()

Deprecated: Use DisablePeriodic() instead.

DisableStopAllAtStopTime()

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

DisableUseTargetNormalVelocity()

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

EnableForcePacking()

Set the value of “Force Packing” to True.

EnablePeriodic()

Set the value of “Periodic” to True.

EnablePeriodicDischarge()

Deprecated: Use EnablePeriodic() instead.

EnableStopAllAtStopTime()

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

EnableUseTargetNormalVelocity()

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

GetAvailableEntryPoints()

Get all available Entry Points.

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

GetDischargeTime(unit: Optional[str] = None)

Deprecated: Use GetInjectionDuration() instead.

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

GetEntryPoint()

Get the “Entry Point”.

Return type: RAInletGeometry, RAFeedConveyor, RARectangularSurface, RACircularSurface, RASurface

GetForcePacking()

Get the value of “Force Packing”.

GetInjectionDuration(unit: Optional[str] = None)

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

GetInputPropertiesList()

Return a list of input properties

GetPeriod(unit: Optional[str] = None)

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

GetPeriodic()

Get the value of “Periodic”.

GetPeriodicDischarge()

Deprecated: Use GetPeriodic() instead.

GetSphInjectionEnabled()

Get the value of “Sph Injection Enabled”.

GetSphTemperature(unit: Optional[str] = None)

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

GetStartTime(unit: Optional[str] = None)

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

GetStopAllAtStopTime()

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

GetStopTime(unit: Optional[str] = None)

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

GetTargetNormalVelocity(unit: Optional[str] = None)

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

GetTonnageList()

Deprecated: Use GetInputPropertiesList() instead.

GetUseTargetNormalVelocity()

Get the value of “Use Target Normal Velocity”.

GetUxLocal(unit: Optional[str] = None)

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

GetUzLocal(unit: Optional[str] = None)

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

IsForcePackingEnabled()

Check if the “Force Packing” is enabled.

IsPeriodicDischargeEnabled()

Deprecated: Use IsPeriodicEnabled() instead.

IsPeriodicEnabled()

Check if the “Periodic” is enabled.

IsStopAllAtStopTimeEnabled()

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

IsUseTargetNormalVelocityEnabled()

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

SetDischargeTime(value: float, unit: Optional[str] = None)

Deprecated: Use SetInjectionDuration() instead.

Parameters:
- value – The value to set.
- unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

SetEntryPoint(value)

Set the “Entry Point”.

:param unicode, RAInletGeometry, RAFeedConveyor, RARectangularSurface, RACircularSurface, RASurface value: : Either the API object wrapping the desired entity or its name.

SetForcePacking(value: bool)

Set the value of “Force Packing”.

Parameters: value – The value to set.

SetInjectionDuration(value: Union[str, float], unit: Optional[str] = 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”.

SetPeriod(value: Union[str, float], unit: Optional[str] = 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”.

SetPeriodic(value: bool)

Set the value of “Periodic”.

Parameters: value – The value to set.

SetPeriodicDischarge(value)

Deprecated: Use SetPeriodic() instead.

Return type: bool

SetSphInjectionEnabled(value: bool)

Set the value of “Sph Injection Enabled”.

Parameters: value – The value to set.

SetSphTemperature(value: Union[str, float], unit: Optional[str] = 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”.

SetStartTime(value: Union[str, float], unit: Optional[str] = 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”.

SetStopAllAtStopTime(value: bool)

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

Parameters: value – The value to set.

SetStopTime(value: Union[str, float], unit: Optional[str] = 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”.

SetTargetNormalVelocity(value: Union[str, float], unit: Optional[str] = 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”.

SetUseTargetNormalVelocity(value: bool)

Set the value of “Use Target Normal Velocity”.

Parameters: value – The value to set.

SetUxLocal(value: Union[str, float], unit: Optional[str] = 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”.

SetUzLocal(value: Union[str, float], unit: Optional[str] = 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”.