RAOutlet

class RAOutlet

Rocky PrePost Scripting wrapper for a single Outlet.

This wrapper class corresponds to an individual entry under the “Inlets and Outlets” item on the project’s data tree. It can be retrieved from the RAStudy via:

input_1 = study.GetElement('Outlet 1>')

Methods:

Name	Description
DisablePrescribedPressure()	Set the value of "Prescribed Pressure" to False.
EnablePrescribedPressure()	Set the value of "Prescribed Pressure" to True.
GetAvailableExitPoints()	Get all available Exit Points.
GetEnabledForParticles()	Get the value of "Enabled For Particles".
GetEnabledForSph()	Get the value of "Enabled For Sph".
GetExitPoint()	Get the "Exit Point".
GetPrescribedPressureEnabled()	Get the value of "Prescribed Pressure Enabled".
GetPressure([unit])	Get the value of "Pressure".
IsPrescribedPressureEnabled()	Check if the "Prescribed Pressure" is enabled.
SetEnabledForParticles(value)	Set the value of "Enabled For Particles".
SetEnabledForSph(value)	Set the value of "Enabled For Sph".
SetExitPoint(value)	Set the "Exit Point".
SetPrescribedPressureEnabled(value)	Set the value of "Prescribed Pressure Enabled".
SetPressure(value[, unit])	Set the value of "Pressure".

DisablePrescribedPressure()

Set the value of “Prescribed Pressure” to False.

EnablePrescribedPressure()

Set the value of “Prescribed Pressure” to True.

GetAvailableExitPoints()

Get all available Exit Points.

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

GetEnabledForParticles()

Get the value of “Enabled For Particles”.

GetEnabledForSph()

Get the value of “Enabled For Sph”.

GetExitPoint()

Get the “Exit Point”.

• Return type: RARectangularSurface, RACircularSurface, RASurface

GetPrescribedPressureEnabled()

Get the value of “Prescribed Pressure Enabled”.

GetPressure(unit: str | None = None)

Get the value of “Pressure”.

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

IsPrescribedPressureEnabled()

Check if the “Prescribed Pressure” is enabled.

SetEnabledForParticles(value: bool)

Set the value of “Enabled For Particles”.

• Parameters: value – The value to set.

SetEnabledForSph(value: bool)

Set the value of “Enabled For Sph”.

• Parameters: value – The value to set.

SetExitPoint(value)

Set the “Exit Point”.

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

SetPrescribedPressureEnabled(value: bool)

Set the value of “Prescribed Pressure Enabled”.

• Parameters: value – The value to set.

SetPressure(value: str | float, unit: str | None = None)

Set the value of “Pressure”.

• 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 “Pa”.