CoilSpring (hwx.inspire.motion)

Creates a Coil Spring.

Coil Springs are used to apply a translational spring-damper force along the line of sight between two parts. Coil Springs provide a linear resistance and/or damping between two objects.

Changing any one of preload, installedLength, freeLength, or k will influence the other values:

  • Changing preload modifies freeLength.

  • Changing installedLength, k, or freeLength modifies the computed preload.

Inherits:

  • MotionConnector (hwx.inspire.motion)

Attributes

active: Bool

c: Double

clevisPinHoles: Attribute

clinear: Bool

coilColor: Color

coilDiameter: Double

coils: Int

compute: Enum

connectionRadius: Double

cspline: Attribute

csplineMethod: Enum

damperColor: Color

damperScale: Double

diameter: Double

direction: Direction

entity1: Attribute

entity2: Attribute

exponent: Double

flipAxis: Bool

freeLength: Double

installedLength: Double

k: Double

klinear: Bool

kspline: Attribute

ksplineMethod: Enum

location1: Location

location2: Location

locked: Bool

max_damping_coeff: Double

max_penetration: Double

mountColor: Color

name: Attribute

overrideConnRadius: Bool

parallelMounts: Bool

parallelMountsJoint: Enum

parts: Attribute

preload: Double

reverseDirection: Bool

rotation: Double

springLimits: Bool

stiffness: Double

type: Enum

visible: Bool

wireDiameter: Double

Properties

Attribute Details

active : Bool

Returns or sets the object activeness.

Setting this on or off sets all children. Setting to True sets all the parents active too.

c : Double (units=”damping”)

The damping value of the coil spring, dafaults to 1 N*s/m.

clevisPinHoles : Attribute

Lists all the cylindrical features from a clevis pin part, that has 3 aligned holes and outside two holes are in the same part.

clinear : Bool

Enables linear damping with the value specified for property c, else uses interpolation methods to get damping value.

coilColor : Color

Specifies the color of the coils around the spring.

coilDiameter : Double (units=”length”)

Specifies the diameter of the coil spring.

coils : Int

Number of coils in the spring, defaults to 10.

This is not specifiable if the spring is of type Damper.

compute : Enum (PRELOAD, FREELENGTH)

Specifies whether the Preload or the Free length is auto computed.

By default Preload force is auto computed.

connectionRadius : Double (units=”length”)

Specifies the radius of the connection.

cspline : Attribute

csplineMethod : Enum (AKIMA, CUBIC, LINEAR)

Specifies the type of interpolation method to use.

Types can be Akima, Cubic or Linear.

damperColor : Color

Specifies the color of the damper of the spring.

damperScale : Double

Use to increase the damper diameter relative to the spring diameter.

The value must be greater than 0, or less than or equal to 1, defaults to 0.5.

diameter : Double (units=”length”)

Used to change the diameter of the coil spring.

direction : Direction

Returns or sets the direction of the object.

entity1 : Attribute

Specifies the starting endpoint of the coil spring is attached to a Feature, Joint or a Fastener.

entity2 : Attribute

Specifies the ending endpoint of the coil spring is attached to a Feature, Joint or a Fastener.

exponent : Double

Exponential value used to generate the stiffness.

This property is not specifiable when the coil spring is of type Damper.

flipAxis : Bool

Allows to flip the axis of the object.

freeLength : Double (units=”length”)

Specifies the length of the coil spring at resting state.

installedLength : Double (units=”length”)

Specifies the distance between the two endpoints of the coil spring.

This is an auto computed value, user cannot modify it.

k : Double (units=”stiffness”)

The stiffness value of the coil spring, defaults to 1000 N/m.

klinear : Bool

Enables linear stiffness with the value specified for property k, else uses interpolation methods to get stiffness value.

kspline : Attribute

ksplineMethod : Enum (AKIMA, CUBIC, LINEAR)

Specifies the type of interpolation method to use.

Types can be Akima, Cubic or Linear.

location1 : Location (units=”length”)

The location of the starting endpoint of the coil spring.

location2 : Location (units=”length”)

The location of the end endpoint of the coil spring.

locked : Bool

If True, prevents the spring from expanding or collapsing during Motion Analysis.

max_damping_coeff : Double (units=”damping”)

Specifies the maximum damping value of the coil spring, defaults to 100 N*s/m.

max_penetration : Double (units=”length”)

Specifies the maximum penetration depth of the coil spring, defaults to 0.0001 m.

mountColor : Color

Specifies the color of the mounts added to coil spring when Parallel Mounts is enabled.

name : Attribute

Returns or sets the name of the object.

It can be any text string, including spaces, although it’s best to avoid using the following characters: ” ‘ * ? and $.

While these characters are allowed, they could create difficulties when you export the model to other applications.

overrideConnRadius : Bool

Allows to override default connection radius value.

parallelMounts : Bool

If True, creates a Cylindrical or Translational joint at the two endpoints of the spring, which prevents the entities from separating during Motion Analysis, defaults to False.

parallelMountsJoint : Enum (CYLINDRICAL, TRANSLATIONAL)

Specifies what type of joint to be created if Parallel Mounts is enabled.

parts : Attribute

Lists all the parts the object is attached to.

preload : Double (units=”force”)

Specifies the force applied to the coil spring to expand or contract to reach its free length.

reverseDirection : Bool

If True, reverses the direction of Preload force.

rotation : Double (units=”angle”)

Specifies the angle of rotation from the shaft of the object.

springLimits : Bool

Prevent the spring from expanding or collapsing beyond its natural limits.

stiffness : Double (units=”stiffness”)

Specifies the spring stiffness.

This property is not specifiable when the coil spring is of type Damper, defaults to 1E+06 N/m.

type : Enum (SPRINGDAMPER, SPRING, DAMPER)

Specifies the type of Coil Spring.

Coil Spring can be of type Spring Damper or only Spring or Damper, defaults to Spring Damper.

visible : Bool

Determines whether the object is visible in the graphics window.

Setting this on or off sets all children. Setting to True sets all the parents visible too.

wireDiameter : Double (units=”length”)

Used to change the diameter of wired coils around the spring.

Property Details

property hasDamper

Specifies if the coil spring has any dampers.

property hasSpring

Specifies if the coil spring has any springs.

property isGrounded

Specifies if the coil spring is a grounded spring or not.

property lowerBound

Minimum distance between end points if springLimits enabled.

property upperBound

Maximum distance between end points if springLimits enabled.