RASurfaceUserProcess

class ansys.rocky.app.ra_process_element.RASurfaceUserProcess

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

SetSTL	Sets the Polyhedron file
GetCenter	rtype: tuple(float, float, float)
SetCenter	Sets the Polyhedron X, Y and Z center
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 RASurfaceUserProcess

Method detail

classmethod RASurfaceUserProcess.GetWrappedClass() → type[rocky30.plugins.sph.surface_user_process.surface_user_process_subject.SurfaceUserProcessSubject]

classmethod RASurfaceUserProcess.GetClassName() → str

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

Sets the Polyhedron file

Parameters:

• filename – string Path to the file to be used

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

RASurfaceUserProcess.GetCenter(unit: str | None = None) → rocky30.base_types.Tuple3F

Return type:

tuple(float, float, float)

Returns:

Returns the X, Y and Z Polyhedron center

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

Sets the Polyhedron X, Y and Z center

Parameters:

• x – float The center X coordinate

• y – The center Y coordinate

• z – The center Z coordinate

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

RASurfaceUserProcess.GetName() → str

Get the value of “Name”.

RASurfaceUserProcess.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

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

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