## On this page

  

 

 # RACylinderGroup

 Last update: 23.02.2026 

<a id="generated.RACylinderGroup"></a>

### *class* RACylinderGroup

**Methods:**

NameDescription[`AddCurve`](#generated.RACylinderGroup.AddCurve)(curve\_name, timesteps, values, unit)Add a curve to the element with a time-steps domain[`GetCenter`](#generated.RACylinderGroup.GetCenter)(\[unit\])[`GetCenterAfterMovement`](#generated.RACylinderGroup.GetCenterAfterMovement)(timestep)Get the Process center position considering the assigned motion.[`GetCurve`](#generated.RACylinderGroup.GetCurve)(curve\_name\[, simulation\_name, ...\])Return the curves for the given element and name.[`GetCurveNames`](#generated.RACylinderGroup.GetCurveNames)(\[simulation\_name\])@param simulation\_name: unicode[`GetCurveNamesAssociation`](#generated.RACylinderGroup.GetCurveNamesAssociation)(\[simulation\_name\])Get this element's curve names.[`GetElementCurve`](#generated.RACylinderGroup.GetElementCurve)(element\_name, curve\_name\[, ...\])Return the curves for the given element and name.[`GetFinalAngle`](#generated.RACylinderGroup.GetFinalAngle)(\[unit\])[`GetInitialAngle`](#generated.RACylinderGroup.GetInitialAngle)(\[unit\])[`GetInternalFactor`](#generated.RACylinderGroup.GetInternalFactor)(\[unit\])[`GetMotionFrame`](#generated.RACylinderGroup.GetMotionFrame)()[`GetNumpyCurve`](#generated.RACylinderGroup.GetNumpyCurve)(curve\_name\[, unit, realization\])Returns a curve as a tuple of numpy arrays (time, property) for the given element and name.[`GetOrientation`](#generated.RACylinderGroup.GetOrientation)(\[unit\])Get the orientation angles.[`GetOrientationFromAngleAndVector`](#generated.RACylinderGroup.GetOrientationFromAngleAndVector)(\[unit\])Get the current orientation in the form of an angle and a vector.[`GetOrientationFromAngles`](#generated.RACylinderGroup.GetOrientationFromAngles)(\[unit\])Get the current orientation in the form of angles.[`GetOrientationFromBasisVector`](#generated.RACylinderGroup.GetOrientationFromBasisVector)()Get the current orientation in the form of three basis vectors.[`GetRotation`](#generated.RACylinderGroup.GetRotation)(\[unit\])[`GetSize`](#generated.RACylinderGroup.GetSize)(\[unit\])[`SetCenter`](#generated.RACylinderGroup.SetCenter)(x, y, z\[, unit\])Sets the cylinder X, Y and Z center[`SetFinalAngle`](#generated.RACylinderGroup.SetFinalAngle)(final\_angle\[, unit\])Sets the final hole radius factor of the final given by the size[`SetInitialAngle`](#generated.RACylinderGroup.SetInitialAngle)(initial\_angle\[, unit\])Sets the initial hole radius factor of the external given by the size[`SetInternalFactor`](#generated.RACylinderGroup.SetInternalFactor)(internal\_factor\[, unit\])Sets the internal hole radius factor of the external given by the size[`SetMotionFrame`](#generated.RACylinderGroup.SetMotionFrame)(motion\_frame)Assign a Motion Frame to the process.[`SetOrientation`](#generated.RACylinderGroup.SetOrientation)(rotation\[, unit\])The rotation is the angles in x, y and z of the rotation in the given unit.[`SetOrientationFromAngleAndVector`](#generated.RACylinderGroup.SetOrientationFromAngleAndVector)(angle, vector)The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector.[`SetOrientationFromAngles`](#generated.RACylinderGroup.SetOrientationFromAngles)(rotation\[, unit, ...\])The rotation is the angles in x, y and z of the rotation.[`SetOrientationFromBasisVector`](#generated.RACylinderGroup.SetOrientationFromBasisVector)(vector\_x, ...)Sets the rotation using three basis vector and changes the orientation mode to Basis Vector.[`SetRotation`](#generated.RACylinderGroup.SetRotation)(x, y, z\[, unit\])Sets the cylinder X, Y and Z rotation[`SetSize`](#generated.RACylinderGroup.SetSize)(x, y, z\[, unit\])Sets the cylinder X, Y and Z magnitude<a id="generated.RACylinderGroup.AddCurve"></a>

#### AddCurve(curve\_name, timesteps, values, unit, realization=None, timesteps\_unit=None, initial\_date=None)

Add a curve to the element with a time-steps domain

- **Parameters:**
    - **curve\_name** (*unicode* *or* *SemanticAssociation*) – The curve’s name or semantic association
    - **timesteps** (*list* \*(\**TimeStep* *) or* *list* \*(\**float* *) or* *TimeSet*) – The list of time-steps, in such case a initial date can be provided The list of elapsed time as floats, in such case a timesteps\_units can be provide or days will be used The curve’s TimeSet
    - **values** (*list* \*(\**float* *)*) – The list of curve image values
    - **unit** (*unicode* *or* *Quantity*) – The curve image unit or quantity
    - **realization** (*unicode*) – An additional keyword to identify the curve realization
    - **timesteps\_units** (*unicode*) – The elapsed time values unit It should be given if a list of floats is used to define the time-set If not given days are assumed
    - **initial\_date** (*tuple* \*(\**int* *,* *int* *,* *int* *,* *int* *,* *int* *,* *int* *) or* *TimeStep*) – The initial date for the time-steps given A tuple with the year, month, day, hour, minute and seconds Or a TimeStep

<a id="generated.RACylinderGroup.GetCenter"></a>

#### GetCenter(unit=None)

- **Return type:**tuple(float, float, float)
- **Returns:**Returns the X, Y and Z center

<a id="generated.RACylinderGroup.GetCenterAfterMovement"></a>

#### GetCenterAfterMovement(timestep: int)

Get the Process center position considering the assigned motion.

- **Returns:**Returns the X, Y and Z center

<a id="generated.RACylinderGroup.GetCurve"></a>

#### GetCurve(curve\_name, simulation\_name=None, realization=None, time\_step=None)

Return the curves for the given element and name.

- **Parameters:**
    - **curve\_name** (*unicode*) – The name of the curve.
    - **simulation\_name** (*unicode*) – An optional parameter for defining the simulation to get the curve from.
    - **realization** (*unicode*) – An additional keyword to identify the curve realization
    - **time\_step** (*TimeStep*) – For transient curves a time-step must be given.

<a id="generated.RACylinderGroup.GetCurveNames"></a>

#### GetCurveNames(simulation\_name=None)

@param simulation\_name: unicode : An optional parameter for defining the simulation to get the curve from.

- **Returns:**list(str) The list of curve names

<a id="generated.RACylinderGroup.GetCurveNamesAssociation"></a>

#### GetCurveNamesAssociation(simulation\_name=None)

Get this element’s curve names.

- **Parameters:****simulation\_name** (*unicode*) – The name of the simulation to query the curve names If None is given the current element simulation will be used
- **Return type:**dict(unicode, ISemanticAssociation)
- **Returns:**The curve names for this element in the given simulation name

<a id="generated.RACylinderGroup.GetElementCurve"></a>

#### GetElementCurve(element\_name, curve\_name, simulation\_name=None, realization=None, time\_step=None)

Return the curves for the given element and name.

- **Parameters:**
    - **element\_name** (*unicode*) – The name of the element
    - **curve\_name** (*unicode*) – The name of the curve
    - **simulation\_name** (*unicode*) – An optional parameter for defining the simulation to get the curve from.
    - **realization** (*unicode*) – An additional keyword to identify the curve realization
    - **time\_step** (*TimeStep*) – For transient curves a time-step must be given.

<a id="generated.RACylinderGroup.GetFinalAngle"></a>

#### GetFinalAngle(unit=None)

- **Return final\_angle:**float The final angle (default dega) of the final given by the size

<a id="generated.RACylinderGroup.GetInitialAngle"></a>

#### GetInitialAngle(unit=None)

- **Return initial\_angle:**float The initial angle (default dega) of the external given by the size

<a id="generated.RACylinderGroup.GetInternalFactor"></a>

#### GetInternalFactor(unit=None)

- **Return internal\_factor:**float The internal hole radius factor (default %) of the external given by the size

<a id="generated.RACylinderGroup.GetMotionFrame"></a>

#### GetMotionFrame()

- **Returns:**The motion frame set in the process, or None if no motion is set.

<a id="generated.RACylinderGroup.GetNumpyCurve"></a>

#### GetNumpyCurve(curve\_name, unit=None, realization=None)

Returns a curve as a tuple of numpy arrays (time, property) for the given element and name.

<a id="generated.RACylinderGroup.GetOrientation"></a>

#### GetOrientation(unit: str = 'dega')

Get the orientation angles. For more specific cases, see: “GetOrientationFromAngles”, “GetOrientationFromAngleAndVector” and “GetOrientationFromBasisVector”.

<a id="generated.RACylinderGroup.GetOrientationFromAngleAndVector"></a>

#### GetOrientationFromAngleAndVector(unit: str = 'dega')

Get the current orientation in the form of an angle and a vector.

<a id="generated.RACylinderGroup.GetOrientationFromAngles"></a>

#### GetOrientationFromAngles(unit: str = 'dega')

Get the current orientation in the form of angles.

<a id="generated.RACylinderGroup.GetOrientationFromBasisVector"></a>

#### GetOrientationFromBasisVector()

Get the current orientation in the form of three basis vectors.

<a id="generated.RACylinderGroup.GetRotation"></a>

#### GetRotation(unit=None)

- **Return type:**tuple(float, float, float)
- **Returns:**Returns the X, Y and Z cylinder rotation

<a id="generated.RACylinderGroup.GetSize"></a>

#### GetSize(unit: str | None = None)

- **Return type:**tuple(float, float, float)
- **Returns:**Returns the X, Y and Z cylinder magnitude

<a id="generated.RACylinderGroup.SetCenter"></a>

#### SetCenter(x: float, y: float, z: float, unit: str | None = None)

Sets the cylinder 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)

<a id="generated.RACylinderGroup.SetFinalAngle"></a>

#### SetFinalAngle(final\_angle, unit=None)

Sets the final hole radius factor of the final given by the size

- **Parameters:**
    - **final\_angle** – float The final angle
    - **unit** (*str* \*|\**None*) – The unit of the given value or None if given in degrees (dega)

<a id="generated.RACylinderGroup.SetInitialAngle"></a>

#### SetInitialAngle(initial\_angle, unit=None)

Sets the initial hole radius factor of the external given by the size

- **Parameters:**
    - **initial\_angle** – float The initial angle
    - **unit** (*str* \*|\**None*) – The unit of the given value or None if given in degrees (dega)

<a id="generated.RACylinderGroup.SetInternalFactor"></a>

#### SetInternalFactor(internal\_factor, unit=None)

Sets the internal hole radius factor of the external given by the size

- **Parameters:**
    - **internal\_factor** – float The internal factor
    - **unit** (*str* \*|\**None*) – The unit of the given value or None if given in percentage (%)

<a id="generated.RACylinderGroup.SetMotionFrame"></a>

#### SetMotionFrame(motion\_frame: RAMotionFrame | str | None)

Assign a Motion Frame to the process.

- **Parameters:****motion\_frame** – Either the API object or its name.

<a id="generated.RACylinderGroup.SetOrientation"></a>

#### SetOrientation(rotation: tuple\[float, float, float\], unit: str = 'dega')

The rotation is the angles in x, y and z of the rotation in the given unit. For more specific methods, see: “SetOrientationFromAngles”, “SetOrientationFromAngleAndVector” and “SetOrientationFromBasisVector”.

<a id="generated.RACylinderGroup.SetOrientationFromAngleAndVector"></a>

#### SetOrientationFromAngleAndVector(angle: float, vector: tuple\[float, float, float\], unit: str = 'dega')

The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector.

<a id="generated.RACylinderGroup.SetOrientationFromAngles"></a>

#### SetOrientationFromAngles(rotation: tuple\[float, float, float\], unit: str = 'dega', local\_angles: bool = True, order: str = 'XYZ')

The rotation is the angles in x, y and z of the rotation. The default unit is dega. Additionally, local\_angles can be used as well an order of the values via kwargs.

<a id="generated.RACylinderGroup.SetOrientationFromBasisVector"></a>

#### SetOrientationFromBasisVector(vector\_x: tuple\[float, float, float\], vector\_y: tuple\[float, float, float\], vector\_z: tuple\[float, float, float\])

Sets the rotation using three basis vector and changes the orientation mode to Basis Vector.

<a id="generated.RACylinderGroup.SetRotation"></a>

#### SetRotation(x, y, z, unit=None)

Sets the cylinder X, Y and Z rotation

- **Parameters:**
    - **x** – float The X rotation
    - **y** – The Y rotation
    - **z** – The Z rotation
    - **unit** (*str* \*|\**None*) – The unit of the given values or None if given in degrees (dega)

<a id="generated.RACylinderGroup.SetSize"></a>

#### SetSize(x: float, y: float, z: float, unit: str | None = None)

Sets the cylinder X, Y and Z magnitude

- **Parameters:**
    - **x** – float The X magnitude
    - **y** – The Y magnitude
    - **z** – The Z magnitude
    - **unit** (*str* \*|\**None*) – The unit of the given values or None if given in meters (m)