Mechanical scripting interface 2025

`Spring`

Last update: 16.07.2025

class Ansys.ACT.Automation.Mechanical.Connections.Spring

Bases: object

Defines a Spring.

Overview

Methods

Name Description
Activate Activate the current object.
AddCommandSnippet Creates a new CommandSnippet
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PromoteToNamedSelection Run the PromoteToNamedSelection action.
PromoteToRemotePoint Run the PromoteToRemotePoint action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
FreeLength Gets or sets the FreeLength.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Load Gets or sets the Load.
LongitudinalDamping Gets or sets the LongitudinalDamping.
LongitudinalStiffness Gets or sets the constant longitudinal stiffness (expressed in N/m).
Material Gets or sets the Material.
MobileAppliedBy Gets or sets the MobileAppliedBy.
MobileBeamCoincidentLengthFactor Gets or sets the Coincident Length Factor on mobile side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.
MobileBeamMaterial Gets or sets the MobileBeamMaterial.
MobileBeamRadius Gets or sets the MobileBeamRadius.
MobileBehavior Gets or sets the MobileBehavior.
MobileBody Gets the MobileBody.
MobileCoordinateSystem Gets or sets the MobileCoordinateSystem.
MobileLocation Gets or sets the MobileLocation.
MobileNodeId Returns Mobile Node Id.
MobilePinballRegion Gets or sets the MobilePinballRegion.
MobileScopeLocation Gets or sets the MobileScopeLocation.
MobileScopingMethod Gets or sets the MobileScopingMethod.
MobileXCoordinate Gets or sets the MobileXCoordinate.
MobileYCoordinate Gets or sets the MobileYCoordinate.
MobileZCoordinate Gets or sets the MobileZCoordinate.
NonLinearLongitudinalStiffness Gets the non linear longitudinal stiffness defined in the tabular data.
PreloadType Gets or sets the PreloadType.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ReferenceAppliedBy Gets or sets the ReferenceAppliedBy.
ReferenceBeamCoincidentLengthFactor Gets or sets the Coincident Length Factor on reference side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.
ReferenceBeamMaterial Gets or sets the ReferenceBeamMaterial.
ReferenceBeamRadius Gets or sets the ReferenceBeamRadius.
ReferenceBehavior Gets or sets the ReferenceBehavior.
ReferenceBody Gets the ReferenceBody.
ReferenceCoordinateSystem Gets or sets the ReferenceCoordinateSystem.
ReferenceLocation Gets or sets the ReferenceLocation.
ReferenceNodeId Returns Reference Node Id.
ReferencePinballRegion Gets or sets the ReferencePinballRegion.
ReferenceScopeLocation Gets or sets the ReferenceScopeLocation.
ReferenceScopingMethod Gets or sets the ReferenceScopingMethod.
ReferenceXCoordinate Gets or sets the ReferenceXCoordinate.
ReferenceYCoordinate Gets or sets the ReferenceYCoordinate.
ReferenceZCoordinate Gets or sets the ReferenceZCoordinate.
Rotation Gets or sets the Rotation.
Scope Gets or sets the Scope.
SpringBehavior Gets or sets the SpringBehavior.
SpringElementAPDLName Gets or sets the SpringElementAPDLName.
SpringLength Gets the SpringLength.
SpringType Gets or sets the SpringType.
Suppressed Gets or sets the Suppressed.
Torque Gets or sets the Torque.
TorsionalDamping Gets or sets the TorsionalDamping.
TorsionalStiffness Gets or sets the TorsionalStiffness.
Visible Gets or sets the Visible.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property Spring.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Spring.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Spring.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property Spring.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Spring.FreeLength : Ansys.Core.Units.Quantity | None

Gets or sets the FreeLength.

property Spring.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Spring.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSSpringAuto | None

Gets the internal object. For advanced usage only.

property Spring.Load : Ansys.Core.Units.Quantity | None

Gets or sets the Load.

property Spring.LongitudinalDamping : Ansys.Core.Units.Quantity | None

Gets or sets the LongitudinalDamping.

property Spring.LongitudinalStiffness : Ansys.Core.Units.Quantity | None

Gets or sets the constant longitudinal stiffness (expressed in N/m).

property Spring.Material : str | None

Gets or sets the Material.

property Spring.MobileAppliedBy : Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the MobileAppliedBy.

property Spring.MobileBeamCoincidentLengthFactor : float | None

Gets or sets the Coincident Length Factor on mobile side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.

property Spring.MobileBeamMaterial : str | None

Gets or sets the MobileBeamMaterial.

property Spring.MobileBeamRadius : Ansys.Core.Units.Quantity | None

Gets or sets the MobileBeamRadius.

property Spring.MobileBehavior : Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the MobileBehavior.

property Spring.MobileBody : str | None

Gets the MobileBody.

property Spring.MobileCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the MobileCoordinateSystem.

property Spring.MobileLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MobileLocation.

property Spring.MobileNodeId : int | None

Returns Mobile Node Id.

property Spring.MobilePinballRegion : Ansys.Core.Units.Quantity | None

Gets or sets the MobilePinballRegion.

property Spring.MobileScopeLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MobileScopeLocation.

property Spring.MobileScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the MobileScopingMethod.

property Spring.MobileXCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the MobileXCoordinate.

property Spring.MobileYCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the MobileYCoordinate.

property Spring.MobileZCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the MobileZCoordinate.

property Spring.NonLinearLongitudinalStiffness : Ansys.ACT.Mechanical.Fields.Field | None

Gets the non linear longitudinal stiffness defined in the tabular data.

property Spring.PreloadType : Ansys.Mechanical.DataModel.Enums.SpringPreloadType | None

Gets or sets the PreloadType.

property Spring.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Spring.ReadOnly : bool | None

Gets or sets the ReadOnly.

property Spring.ReferenceAppliedBy : Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the ReferenceAppliedBy.

property Spring.ReferenceBeamCoincidentLengthFactor : float | None

Gets or sets the Coincident Length Factor on reference side that scales the stiffness of the connection between the beam elements and the remote point. This property is applicable when the Behavior property is set to “Beam”. Default: 1.

property Spring.ReferenceBeamMaterial : str | None

Gets or sets the ReferenceBeamMaterial.

property Spring.ReferenceBeamRadius : Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceBeamRadius.

property Spring.ReferenceBehavior : Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the ReferenceBehavior.

property Spring.ReferenceBody : str | None

Gets the ReferenceBody.

property Spring.ReferenceCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the ReferenceCoordinateSystem.

property Spring.ReferenceLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReferenceLocation.

property Spring.ReferenceNodeId : int | None

Returns Reference Node Id.

property Spring.ReferencePinballRegion : Ansys.Core.Units.Quantity | None

Gets or sets the ReferencePinballRegion.

property Spring.ReferenceScopeLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReferenceScopeLocation.

property Spring.ReferenceScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ReferenceScopingMethod.

property Spring.ReferenceXCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceXCoordinate.

property Spring.ReferenceYCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceYCoordinate.

property Spring.ReferenceZCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceZCoordinate.

property Spring.Rotation : Ansys.Core.Units.Quantity | None

Gets or sets the Rotation.

property Spring.Scope : Ansys.Mechanical.DataModel.Enums.SpringScopingType | None

Gets or sets the Scope.

property Spring.SpringBehavior : Ansys.Mechanical.DataModel.Enums.SpringBehavior | None

Gets or sets the SpringBehavior.

property Spring.SpringElementAPDLName : str | None

Gets or sets the SpringElementAPDLName.

property Spring.SpringLength : Ansys.Core.Units.Quantity | None

Gets the SpringLength.

property Spring.SpringType : Ansys.Mechanical.DataModel.Enums.SpringType | None

Gets or sets the SpringType.

property Spring.Suppressed : bool | None

Gets or sets the Suppressed.

property Spring.Torque : Ansys.Core.Units.Quantity | None

Gets or sets the Torque.

property Spring.TorsionalDamping : Ansys.Core.Units.Quantity | None

Gets or sets the TorsionalDamping.

property Spring.TorsionalStiffness : Ansys.Core.Units.Quantity | None

Gets or sets the TorsionalStiffness.

property Spring.Visible : bool | None

Gets or sets the Visible.

property Spring.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

Spring.Activate() → None

Activate the current object.

Spring.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

Spring.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Spring.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

Spring.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

Spring.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

Spring.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Spring.Delete() → None

Run the Delete action.

Spring.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Spring.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Spring.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Spring.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

Spring.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Spring.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

Spring.PromoteToRemotePoint() → Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

Spring.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

Spring.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Spring.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.

Spring.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

Connect with Ansys