RAPrescribedForce#

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

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper representing an Additional Force 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('Additional Force')
additional_force = motion_1.GetTypeObject()

Overview#

GetWrappedClass

GetClassName

GetForceValue

Get the value of “Force Value”.

SetForceValue

Set the values of “Force Value”.

Import detail#

from ansys.rocky.app.motion.ra_prescribed_force import RAPrescribedForce

Method detail#

classmethod RAPrescribedForce.GetWrappedClass()#
classmethod RAPrescribedForce.GetClassName()#
RAPrescribedForce.GetForceValue(unit: str | None = None) → list[float]#

Get the value of “Force Value”.

Parameters:

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

RAPrescribedForce.SetForceValue(values: collections.abc.Sequence[str | float], unit: str | None = None) → None#

Set the values of “Force Value”.

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

Raises:

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