RAVibration#

class ansys.rocky.app.motion.ra_vibration.RAVibration(id: str, model_id: str | None = None)#

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper representing a Vibration motion.

Retrieve this specific wrapper after setting the correct motion type on a RAMotion. For example:

motions = motion_frame.GetMotions()
motion_1 = motions.New()
motion_1.SetType('Vibration')
vibration = motion_1.GetTypeObject()

Overview#

GetWrappedClass

GetClassName

GetAmplitudeVariation

Get the value of “Amplitude Variation”.

SetAmplitudeVariation

Set the value of “Amplitude Variation”.

GetDirection

Get the value of “Direction”.

SetDirection

Set the values of “Direction”.

GetFrequencyVariation

Get the value of “Frequency Variation”.

SetFrequencyVariation

Set the value of “Frequency Variation”.

GetInitialAmplitude

Get the value of “Initial Amplitude”.

SetInitialAmplitude

Set the value of “Initial Amplitude”.

GetInitialFrequency

Get the value of “Initial Frequency”.

SetInitialFrequency

Set the value of “Initial Frequency”.

GetInitialPhase

Get the value of “Initial Phase”.

SetInitialPhase

Set the value of “Initial Phase”.

Import detail#

from ansys.rocky.app.motion.ra_vibration import RAVibration

Method detail#

classmethod RAVibration.GetWrappedClass()#
classmethod RAVibration.GetClassName()#
RAVibration.GetAmplitudeVariation(unit: str | None = None) → float#

Get the value of “Amplitude Variation”.

Parameters:

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

RAVibration.SetAmplitudeVariation(value: str | float, unit: str | None = None) → None#

Set the value of “Amplitude Variation”.

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

RAVibration.GetDirection() → list[float]#

Get the value of “Direction”.

RAVibration.SetDirection(values: list[str | float]) → None#

Set the values of “Direction”.

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.

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RAVibration.GetFrequencyVariation(unit: str | None = None) → float#

Get the value of “Frequency Variation”.

Parameters:

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

RAVibration.SetFrequencyVariation(value: str | float, unit: str | None = None) → None#

Set the value of “Frequency Variation”.

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 “Hz/s”.

RAVibration.GetInitialAmplitude(unit: str | None = None) → float#

Get the value of “Initial Amplitude”.

Parameters:

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

RAVibration.SetInitialAmplitude(value: str | float, unit: str | None = None) → None#

Set the value of “Initial Amplitude”.

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

RAVibration.GetInitialFrequency(unit: str | None = None) → float#

Get the value of “Initial Frequency”.

Parameters:

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

RAVibration.SetInitialFrequency(value: str | float, unit: str | None = None) → None#

Set the value of “Initial Frequency”.

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

RAVibration.GetInitialPhase(unit: str | None = None) → float#

Get the value of “Initial Phase”.

Parameters:

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

RAVibration.SetInitialPhase(value: str | float, unit: str | None = None) → None#

Set the value of “Initial Phase”.

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