RAReceivingConveyor

class ansys.rocky.app.conveyors.ra_receiving_conveyor.RAReceivingConveyor

Bases: ansys.rocky.app.conveyors.ra_base_conveyor.RABaseConveyor, ansys.rocky.app.ra_addins.ElementWithAddins

Rocky api Receiving Conveyor model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetAccelerationPeriod	Get the value of “Acceleration Period”.
SetAccelerationPeriod	Set the value of “Acceleration Period”.
GetBeginningStopTime	Get the value of “Beginning Stop Time”.
SetBeginningStopTime	Set the value of “Beginning Stop Time”.
GetBeltSpeed	Get the value of “Belt Speed”.
SetBeltSpeed	Set the value of “Belt Speed”.
GetDecelerationPeriod	Get the value of “Deceleration Period”.
SetDecelerationPeriod	Set the value of “Deceleration Period”.
GetBeginningStartTime	Get the value of “Beginning Start Time”.
SetBeginningStartTime	Set the value of “Beginning Start Time”.
GetCapillaryFrictionCoefficient	Get the value of “Capillary Friction Coefficient”.
SetCapillaryFrictionCoefficient	Set the value of “Capillary Friction Coefficient”.
GetBeltThickness	Get the value of “Belt Thickness”.
SetBeltThickness	Set the value of “Belt Thickness”.
GetBeltWidth	Get the value of “Belt Width”.
SetBeltWidth	Set the value of “Belt Width”.
GetLength	Get the value of “Length”.
SetLength	Set the value of “Length”.
GetTemperature	Get the value of “Temperature”.
SetTemperature	Set the value of “Temperature”.
GetThermalBoundaryConditionType	Get “Thermal Boundary Condition Type” as a string.
SetThermalBoundaryConditionType	Set the value of “Thermal Boundary Condition Type”.
GetValidThermalBoundaryConditionTypeValues	Get a list of all possible values for “Thermal Boundary Condition Type”.
GetTriangleSize	Get the value of “Triangle Size”.
SetTriangleSize	Set the value of “Triangle Size”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetAlignmentAngle	Get the value of “Alignment Angle”.
SetAlignmentAngle	Set the value of “Alignment Angle”.
GetBeltInclineAngle	Get the value of “Belt Incline Angle”.
SetBeltInclineAngle	Set the value of “Belt Incline Angle”.
GetHorizontalOffset	Get the value of “Horizontal Offset”.
SetHorizontalOffset	Set the value of “Horizontal Offset”.
GetOutOfPlaneOffset	Get the value of “Out of Plane Offset”.
SetOutOfPlaneOffset	Set the value of “Out of Plane Offset”.
GetReturnBeltAngle	Get the value of “Return Belt Angle”.
SetReturnBeltAngle	Set the value of “Return Belt Angle”.
GetVerticalOffset	Get the value of “Vertical Offset”.
SetVerticalOffset	Set the value of “Vertical Offset”.
GetSkirtboardHeight	Get the value of “Skirtboard Height”.
SetSkirtboardHeight	Set the value of “Skirtboard Height”.
GetHeightOffset	Get the value of “Height Offset”.
SetHeightOffset	Set the value of “Height Offset”.
GetSkirtboardLength	Get the value of “Skirtboard Length”.
SetSkirtboardLength	Set the value of “Skirtboard Length”.
GetLengthOffset	Get the value of “Length Offset”.
SetLengthOffset	Set the value of “Length Offset”.
GetWidth	Get the value of “Width”.
SetWidth	Set the value of “Width”.
GetSphBoundaryType	Get “Sph Boundary Type” as a string.
SetSphBoundaryType	Set the value of “Sph Boundary Type”.
GetValidSphBoundaryTypeValues	Get a list of all possible values for “Sph Boundary Type”.
GetSurfaceTensionContactAngle	Get the value of “Surface Tension Contact Angle”.
SetSurfaceTensionContactAngle	Set the value of “Surface Tension Contact Angle”.
GetMaterial	Get the “Material”.
SetMaterial	Set the “Material”.
GetAvailableMaterials	Get all available Materials.

Import detail

from ansys.rocky.app.conveyors.ra_receiving_conveyor import RAReceivingConveyor

Method detail

classmethod RAReceivingConveyor.GetWrappedClass()

classmethod RAReceivingConveyor.GetClassName()

RAReceivingConveyor.GetAccelerationPeriod(unit: str | None = None) → float

Get the value of “Acceleration Period”.

Parameters:

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

RAReceivingConveyor.SetAccelerationPeriod(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetBeginningStopTime(unit: str | None = None) → float

Get the value of “Beginning Stop Time”.

Parameters:

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

RAReceivingConveyor.SetBeginningStopTime(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetBeltSpeed(unit: str | None = None) → float

Get the value of “Belt Speed”.

Parameters:

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

RAReceivingConveyor.SetBeltSpeed(value: str | float, unit: str | None = None) → None

Set the value of “Belt Speed”.

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

RAReceivingConveyor.GetDecelerationPeriod(unit: str | None = None) → float

Get the value of “Deceleration Period”.

Parameters:

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

RAReceivingConveyor.SetDecelerationPeriod(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetBeginningStartTime(unit: str | None = None) → float

Get the value of “Beginning Start Time”.

Parameters:

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

RAReceivingConveyor.SetBeginningStartTime(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetCapillaryFrictionCoefficient() → float

Get the value of “Capillary Friction Coefficient”.

RAReceivingConveyor.SetCapillaryFrictionCoefficient(value: str | float) → None

Set the value of “Capillary Friction Coefficient”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RAReceivingConveyor.GetBeltThickness(unit: str | None = None) → float

Get the value of “Belt Thickness”.

Parameters:

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

RAReceivingConveyor.SetBeltThickness(value: str | float, unit: str | None = None) → None

Set the value of “Belt Thickness”.

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

RAReceivingConveyor.GetBeltWidth(unit: str | None = None) → float

Get the value of “Belt Width”.

Parameters:

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

RAReceivingConveyor.SetBeltWidth(value: str | float, unit: str | None = None) → None

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

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

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

RAReceivingConveyor.GetTemperature(unit: str | None = None) → float

Get the value of “Temperature”.

Parameters:

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

RAReceivingConveyor.SetTemperature(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetThermalBoundaryConditionType() → str

Get “Thermal Boundary Condition Type” as a string.

Returns:

The returned value will be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’].

RAReceivingConveyor.SetThermalBoundaryConditionType(value: str) → None

Set the value of “Thermal Boundary Condition Type”.

Parameters:

value – The value to set. Must be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’].

Raises:

RockyApiError – If value is not a valid “Thermal Boundary Condition Type” option.

RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues() → list[str]

Get a list of all possible values for “Thermal Boundary Condition Type”.

Returns:

The returned list is [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’].

RAReceivingConveyor.GetTriangleSize(unit: str | None = None) → float

Get the value of “Triangle Size”.

Parameters:

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

RAReceivingConveyor.SetTriangleSize(value: str | float, unit: str | None = None) → None

Set the value of “Triangle Size”.

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

RAReceivingConveyor.GetName() → str

Get the value of “Name”.

RAReceivingConveyor.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

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

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

RAReceivingConveyor.GetBeltInclineAngle(unit: str | None = None) → float

Get the value of “Belt Incline Angle”.

Parameters:

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

RAReceivingConveyor.SetBeltInclineAngle(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetHorizontalOffset(unit: str | None = None) → float

Get the value of “Horizontal Offset”.

Parameters:

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

RAReceivingConveyor.SetHorizontalOffset(value: str | float, unit: str | None = None) → None

Set the value of “Horizontal Offset”.

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

RAReceivingConveyor.GetOutOfPlaneOffset(unit: str | None = None) → float

Get the value of “Out of Plane Offset”.

Parameters:

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

RAReceivingConveyor.SetOutOfPlaneOffset(value: str | float, unit: str | None = None) → None

Set the value of “Out of Plane Offset”.

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

RAReceivingConveyor.GetReturnBeltAngle(unit: str | None = None) → float

Get the value of “Return Belt Angle”.

Parameters:

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

RAReceivingConveyor.SetReturnBeltAngle(value: str | float, unit: str | None = None) → None

Set the value of “Return Belt 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 “rad”.

RAReceivingConveyor.GetVerticalOffset(unit: str | None = None) → float

Get the value of “Vertical Offset”.

Parameters:

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

RAReceivingConveyor.SetVerticalOffset(value: str | float, unit: str | None = None) → None

Set the value of “Vertical Offset”.

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

RAReceivingConveyor.GetSkirtboardHeight(unit: str | None = None) → float

Get the value of “Skirtboard Height”.

Parameters:

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

RAReceivingConveyor.SetSkirtboardHeight(value: str | float, unit: str | None = None) → None

Set the value of “Skirtboard Height”.

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

RAReceivingConveyor.GetHeightOffset(unit: str | None = None) → float

Get the value of “Height Offset”.

Parameters:

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

RAReceivingConveyor.SetHeightOffset(value: str | float, unit: str | None = None) → None

Set the value of “Height Offset”.

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

RAReceivingConveyor.GetSkirtboardLength(unit: str | None = None) → float

Get the value of “Skirtboard Length”.

Parameters:

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

RAReceivingConveyor.SetSkirtboardLength(value: str | float, unit: str | None = None) → None

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

RAReceivingConveyor.GetLengthOffset(unit: str | None = None) → float

Get the value of “Length Offset”.

Parameters:

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

RAReceivingConveyor.SetLengthOffset(value: str | float, unit: str | None = None) → None

Set the value of “Length Offset”.

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

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

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

RAReceivingConveyor.GetSphBoundaryType() → str

Get “Sph Boundary Type” as a string.

Returns:

The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’].

RAReceivingConveyor.SetSphBoundaryType(value: str) → None

Set the value of “Sph Boundary Type”.

Parameters:

value – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’].

Raises:

RockyApiError – If value is not a valid “Sph Boundary Type” option.

RAReceivingConveyor.GetValidSphBoundaryTypeValues() → list[str]

Get a list of all possible values for “Sph Boundary Type”.

Returns:

The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’].

RAReceivingConveyor.GetSurfaceTensionContactAngle(unit: str | None = None) → float

Get the value of “Surface Tension Contact Angle”.

Parameters:

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

RAReceivingConveyor.SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) → None

Set the value of “Surface Tension Contact 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”.

RAReceivingConveyor.GetMaterial()

Get the “Material”.

Return type:

RASolidMaterial

RAReceivingConveyor.SetMaterial(value) → None

Set the “Material”.

:param unicode, RASolidMaterial value:

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

RAReceivingConveyor.GetAvailableMaterials()

Get all available Materials.

Return type:

List[RASolidMaterial] A list of RASolidMaterial.