RAPolyhedronProcess

class ansys.rocky.app.ra_process_element.RAPolyhedronProcess

Bases: RAUserProcess, ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin, ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin

Base class for UserProcesses

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetCenter	return:
SetCenter	Sets the Polyhedron X, Y and Z center
GetCenterAfterMovement	Get the Process center position considering the assigned motion.
SetSTL	Sets the Polyhedron file
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetScale	Get the value of “Scale”.
SetScale	Set the values of “Scale”.

Import detail

from ansys.rocky.app.ra_process_element import RAPolyhedronProcess

Method detail

classmethod RAPolyhedronProcess.GetWrappedClass() → type[rocky30.process.user_process.polyhedron_process_with_movement.PolyhedronProcessWithMovement]

classmethod RAPolyhedronProcess.GetClassName() → str

RAPolyhedronProcess.GetCenter(unit=None) → rocky30.base_types.Tuple3F

Returns:

Returns the X, Y and Z Polyhedron center

RAPolyhedronProcess.SetCenter(x: float, y: float, z: float, unit: str | None = None) → None

Sets the Polyhedron X, Y and Z center

Parameters:

• x – The center X coordinate

• y – The center Y coordinate

• z – The center Z coordinate

• unit – The unit of the given values or None if given in meters (m)

RAPolyhedronProcess.GetCenterAfterMovement(timestep: int) → rocky30.base_types.Tuple3F

Get the Process center position considering the assigned motion.

Returns:

Returns the X, Y and Z center

RAPolyhedronProcess.SetSTL(filename: str, mesh_unit: str | None = None) → None

Sets the Polyhedron file

Parameters:

• filename – Path to the file to be used

• mesh_unit – unit to be used for the mesh, or None if given in meters (m)

RAPolyhedronProcess.GetName() → str

Get the value of “Name”.

RAPolyhedronProcess.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAPolyhedronProcess.GetScale(unit: str | None = None) → list[float]

Get the value of “Scale”.

Parameters:

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

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

Set the values of “Scale”.

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.