RACircularSurface

class ansys.rocky.app.ra_circular_surface.RACircularSurface

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

Rocky API for “Circular Surface” model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

HasMotionFrame	Whether the geometry is linked to a motion frame.
GetCenter	Get the value of “Center”.
SetCenter	Set the values of “Center”.
GetMinRadius	Get the value of “Min Radius”.
SetMinRadius	Set the value of “Min Radius”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetMaxRadius	Get the value of “Max Radius”.
SetMaxRadius	Set the value of “Max Radius”.

Import detail

from ansys.rocky.app.ra_circular_surface import RACircularSurface

Method detail

classmethod RACircularSurface.GetWrappedClass() → type[object]

classmethod RACircularSurface.GetClassName() → str

RACircularSurface.HasMotionFrame() → bool

Whether the geometry is linked to a motion frame.

Returns:

True if geometry is linked to a motion frame False otherwise

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

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

RACircularSurface.GetMinRadius(unit: str | None = None) → float

Get the value of “Min Radius”.

Parameters:

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

RACircularSurface.SetMinRadius(value: str | float, unit: str | None = None) → None

Set the value of “Min Radius”.

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

RACircularSurface.GetName() → str

Get the value of “Name”.

RACircularSurface.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RACircularSurface.GetMaxRadius(unit: str | None = None) → float

Get the value of “Max Radius”.

Parameters:

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

RACircularSurface.SetMaxRadius(value: str | float, unit: str | None = None) → None

Set the value of “Max Radius”.

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