RAOutlet

class ansys.rocky.app.ra_outlet.RAOutlet(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

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>')

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetEnabledForParticles	Get the value of “Enabled For Particles”.
SetEnabledForParticles	Set the value of “Enabled For Particles”.
GetEnabledForSph	Get the value of “Enabled For Sph”.
SetEnabledForSph	Set the value of “Enabled For Sph”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetPressure	Get the value of “Pressure”.
SetPressure	Set the value of “Pressure”.
GetPrescribedPressureEnabled	Get the value of “Prescribed Pressure Enabled”.
SetPrescribedPressureEnabled	Set the value of “Prescribed Pressure Enabled”.
EnablePrescribedPressure	Set the value of “Prescribed Pressure” to True.
DisablePrescribedPressure	Set the value of “Prescribed Pressure” to False.
IsPrescribedPressureEnabled	Check if the “Prescribed Pressure” is enabled.
GetExitPoint	Get the “Exit Point”.
SetExitPoint	Set the “Exit Point”.
GetAvailableExitPoints	Get all available Exit Points.

Import detail

from ansys.rocky.app.ra_outlet import RAOutlet

Method detail

classmethod RAOutlet.GetWrappedClass()

classmethod RAOutlet.GetClassName() → str

RAOutlet.GetEnabledForParticles() → bool

Get the value of “Enabled For Particles”.

RAOutlet.SetEnabledForParticles(value: bool) → None

Set the value of “Enabled For Particles”.

Parameters:

value – The value to set.

RAOutlet.GetEnabledForSph() → bool

Get the value of “Enabled For Sph”.

RAOutlet.SetEnabledForSph(value: bool) → None

Set the value of “Enabled For Sph”.

Parameters:

value – The value to set.

RAOutlet.GetName() → str

Get the value of “Name”.

RAOutlet.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAOutlet.GetPressure(unit: str | None = None) → float

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

RAOutlet.SetPressure(value: str | float, unit: str | None = 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”.

RAOutlet.GetPrescribedPressureEnabled() → bool

Get the value of “Prescribed Pressure Enabled”.

RAOutlet.SetPrescribedPressureEnabled(value: bool) → None

Set the value of “Prescribed Pressure Enabled”.

Parameters:

value – The value to set.

RAOutlet.EnablePrescribedPressure() → None

Set the value of “Prescribed Pressure” to True.

RAOutlet.DisablePrescribedPressure() → None

Set the value of “Prescribed Pressure” to False.

RAOutlet.IsPrescribedPressureEnabled() → bool

Check if the “Prescribed Pressure” is enabled.

RAOutlet.GetExitPoint()

Get the “Exit Point”.

Return type:

RARectangularSurface, RACircularSurface, RASurface

RAOutlet.SetExitPoint(value) → None

Set the “Exit Point”.

:param unicode, RARectangularSurface, RACircularSurface, RASurface value:

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

RAOutlet.GetAvailableExitPoints()

Get all available Exit Points.

Return type:

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