Rocky PrePost scripting 2025 R1

RASpringDashpotForce

Last update: 17.07.2025

class RASpringDashpotForce

Rocky PrePost Scripting wrapper representing a Spring-Dashpot 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('Spring-Dashpot Force')
spring_force = motion_1.GetTypeObject()

Methods:

Name Description
GetDashpotCoefficient([unit]) Get the value of "Dashpot Coefficient".
GetDirection() Get "Direction" as a string.
GetSpringCoefficient([unit]) Get the value of "Spring Coefficient".
GetValidDirectionValues() Get a list of all possible values for "Direction".
SetDashpotCoefficient(value[, unit]) Set the value of "Dashpot Coefficient".
SetDirection(value) Set the value of "Direction".
SetSpringCoefficient(value[, unit]) Set the value of "Spring Coefficient".

GetDashpotCoefficient(unit: Optional[str] = None)

Get the value of “Dashpot Coefficient”.

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

GetDirection()

Get “Direction” as a string.

  • Returns: The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’].

GetSpringCoefficient(unit: Optional[str] = None)

Get the value of “Spring Coefficient”.

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

GetValidDirectionValues()

Get a list of all possible values for “Direction”.

  • Returns: The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’].

SetDashpotCoefficient(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Dashpot Coefficient”.

  • 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 “N.s/m”.

SetDirection(value: str)

Set the value of “Direction”.

  • Parameters: value – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’].
  • Raises: RockyApiError – If value is not a valid “Direction” option.

SetSpringCoefficient(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Spring Coefficient”.

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

Connect with Ansys