RAInletGeometry

class ansys.rocky.app.ra_inlet.RAInletGeometry

Bases: ansys.rocky.app.ra_base_geometry.RABaseGeometry

Rocky API Inlet model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

SetGeometryType	Sets Inlet geometry type, rectangular or circular
GetGeometryType	Get the Inlet geometry type, which is either ‘rectangular’ or ‘circular’.
GetRectangularSize	Get the rectangular length and width of the inlet.
SetRectangularSize	Sets inlet rectangular size.
GetCircularMinMaxRadius	Get the minimum and maximum radiuses for circular inlets.
SetCircularMinMaxRadius	Set the minimum and maximum radiuses for circular inlets.
GetAlignmentAngle	Get the value of “Alignment Angle”.
SetAlignmentAngle	Set the value of “Alignment Angle”.
GetCenter	Get the value of “Center”.
SetCenter	Set the values of “Center”.
GetLength	Get the value of “Length”.
SetLength	Set the value of “Length”.
GetWidth	Get the value of “Width”.
SetWidth	Set the value of “Width”.
GetInclineAngle	Get the value of “Incline Angle”.
SetInclineAngle	Set the value of “Incline Angle”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.

Import detail

from ansys.rocky.app.ra_inlet import RAInletGeometry

Method detail

classmethod RAInletGeometry.GetWrappedClass()

RAInletGeometry.SetGeometryType(geometry_type: str) → None

Sets Inlet geometry type, rectangular or circular

Parameters:

geometry_type – Inlet geometry’s type, ‘rectangular’ or ‘circular’.

RAInletGeometry.GetGeometryType() → str

Get the Inlet geometry type, which is either ‘rectangular’ or ‘circular’.

RAInletGeometry.GetRectangularSize(unit: str | None = None) → tuple[float, float]

Get the rectangular length and width of the inlet.

Parameters:

unit – The optional unit of the returned values. If no unit is passed, the values will be in ‘m’.

Returns:

A (length, width) tuple.

RAInletGeometry.SetRectangularSize(length: float, width: float, unit: str | None = None) → None

Sets inlet rectangular size.

Parameters:

• width – Inlet width

• length – Inlet length

• unit – The optional unit. If no unit is passed, ‘m’ is used.

classmethod RAInletGeometry.GetClassName() → str

RAInletGeometry.GetCircularMinMaxRadius(unit: str | None = None) → tuple[float, float]

Get the minimum and maximum radiuses for circular inlets.

Parameters:

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

Returns:

A tuple with (minimum_radius, maximum_radius)

RAInletGeometry.SetCircularMinMaxRadius(min_radius: float, max_radius: float, unit: str | None = None) → None

Set the minimum and maximum radiuses for circular inlets.

Parameters:

unit – The unit for the radiuses. If no unit is provided, the radiuses will be assumed to be in “m”.

RAInletGeometry.GetAlignmentAngle(unit: str | None = None) → float

Get the value of “Alignment Angle”.

Parameters:

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

RAInletGeometry.SetAlignmentAngle(value: str | float, unit: str | None = None) → None

Set the value of “Alignment Angle”.

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

RAInletGeometry.GetCenter(unit: str | None = None) → list[float]

Get the value of “Center”.

Parameters:

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

RAInletGeometry.SetCenter(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Center”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

• unit – The unit for values. If no unit is provided, values is assumed to be in “m”.

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RAInletGeometry.GetLength(unit: str | None = None) → float

Get the value of “Length”.

Parameters:

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

RAInletGeometry.SetLength(value: str | float, unit: str | None = None) → None

Set the value of “Length”.

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

RAInletGeometry.GetWidth(unit: str | None = None) → float

Get the value of “Width”.

Parameters:

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

RAInletGeometry.SetWidth(value: str | float, unit: str | None = None) → None

Set the value of “Width”.

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

RAInletGeometry.GetInclineAngle(unit: str | None = None) → float

Get the value of “Incline Angle”.

Parameters:

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

RAInletGeometry.SetInclineAngle(value: str | float, unit: str | None = None) → None

Set the value of “Incline Angle”.

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

RAInletGeometry.GetName() → str

Get the value of “Name”.

RAInletGeometry.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.