.. vale off :class:`Spring` =============== .. py:class:: ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.Connections.Spring Bases: :py:obj:`object` Defines a Spring. .. !! processed by numpydoc !! .. py:currentmodule:: Spring Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddCommandSnippet` - Creates a new CommandSnippet * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PromoteToNamedSelection` - Run the PromoteToNamedSelection action. * - :py:attr:`~PromoteToRemotePoint` - Run the PromoteToRemotePoint action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~RenameBasedOnDefinition` - Run the RenameBasedOnDefinition action. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~FreeLength` - Gets or sets the FreeLength. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Load` - Gets or sets the Load. * - :py:attr:`~LongitudinalDamping` - Gets or sets the LongitudinalDamping. * - :py:attr:`~LongitudinalStiffness` - Gets or sets the constant longitudinal stiffness (expressed in N/m). * - :py:attr:`~Material` - Gets or sets the Material. * - :py:attr:`~MobileAppliedBy` - Gets or sets the MobileAppliedBy. * - :py:attr:`~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. * - :py:attr:`~MobileBeamMaterial` - Gets or sets the MobileBeamMaterial. * - :py:attr:`~MobileBeamRadius` - Gets or sets the MobileBeamRadius. * - :py:attr:`~MobileBehavior` - Gets or sets the MobileBehavior. * - :py:attr:`~MobileBody` - Gets the MobileBody. * - :py:attr:`~MobileCoordinateSystem` - Gets or sets the MobileCoordinateSystem. * - :py:attr:`~MobileLocation` - Gets or sets the MobileLocation. * - :py:attr:`~MobileNodeId` - Returns Mobile Node Id. * - :py:attr:`~MobilePinballRegion` - Gets or sets the MobilePinballRegion. * - :py:attr:`~MobileScopeLocation` - Gets or sets the MobileScopeLocation. * - :py:attr:`~MobileScopingMethod` - Gets or sets the MobileScopingMethod. * - :py:attr:`~MobileXCoordinate` - Gets or sets the MobileXCoordinate. * - :py:attr:`~MobileYCoordinate` - Gets or sets the MobileYCoordinate. * - :py:attr:`~MobileZCoordinate` - Gets or sets the MobileZCoordinate. * - :py:attr:`~NonLinearLongitudinalStiffness` - Gets the non linear longitudinal stiffness defined in the tabular data. * - :py:attr:`~PreloadType` - Gets or sets the PreloadType. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~ReferenceAppliedBy` - Gets or sets the ReferenceAppliedBy. * - :py:attr:`~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. * - :py:attr:`~ReferenceBeamMaterial` - Gets or sets the ReferenceBeamMaterial. * - :py:attr:`~ReferenceBeamRadius` - Gets or sets the ReferenceBeamRadius. * - :py:attr:`~ReferenceBehavior` - Gets or sets the ReferenceBehavior. * - :py:attr:`~ReferenceBody` - Gets the ReferenceBody. * - :py:attr:`~ReferenceCoordinateSystem` - Gets or sets the ReferenceCoordinateSystem. * - :py:attr:`~ReferenceLocation` - Gets or sets the ReferenceLocation. * - :py:attr:`~ReferenceNodeId` - Returns Reference Node Id. * - :py:attr:`~ReferencePinballRegion` - Gets or sets the ReferencePinballRegion. * - :py:attr:`~ReferenceScopeLocation` - Gets or sets the ReferenceScopeLocation. * - :py:attr:`~ReferenceScopingMethod` - Gets or sets the ReferenceScopingMethod. * - :py:attr:`~ReferenceXCoordinate` - Gets or sets the ReferenceXCoordinate. * - :py:attr:`~ReferenceYCoordinate` - Gets or sets the ReferenceYCoordinate. * - :py:attr:`~ReferenceZCoordinate` - Gets or sets the ReferenceZCoordinate. * - :py:attr:`~Rotation` - Gets or sets the Rotation. * - :py:attr:`~Scope` - Gets or sets the Scope. * - :py:attr:`~SpringBehavior` - Gets or sets the SpringBehavior. * - :py:attr:`~SpringElementAPDLName` - Gets or sets the SpringElementAPDLName. * - :py:attr:`~SpringLength` - Gets the SpringLength. * - :py:attr:`~SpringType` - Gets or sets the SpringType. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~Torque` - Gets or sets the Torque. * - :py:attr:`~TorsionalDamping` - Gets or sets the TorsionalDamping. * - :py:attr:`~TorsionalStiffness` - Gets or sets the TorsionalStiffness. * - :py:attr:`~Visible` - Gets or sets the Visible. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: FreeLength :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the FreeLength. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSSpringAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Load :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the Load. .. !! processed by numpydoc !! .. py:property:: LongitudinalDamping :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the LongitudinalDamping. .. !! processed by numpydoc !! .. py:property:: LongitudinalStiffness :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the constant longitudinal stiffness (expressed in N/m). .. !! processed by numpydoc !! .. py:property:: Material :type: Optional[str] Gets or sets the Material. .. !! processed by numpydoc !! .. py:property:: MobileAppliedBy :type: Optional[Ansys.Mechanical.DataModel.Enums.RemoteApplicationType] Gets or sets the MobileAppliedBy. .. !! processed by numpydoc !! .. py:property:: MobileBeamCoincidentLengthFactor :type: Optional[float] 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. .. !! processed by numpydoc !! .. py:property:: MobileBeamMaterial :type: Optional[str] Gets or sets the MobileBeamMaterial. .. !! processed by numpydoc !! .. py:property:: MobileBeamRadius :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MobileBeamRadius. .. !! processed by numpydoc !! .. py:property:: MobileBehavior :type: Optional[Ansys.Mechanical.DataModel.Enums.LoadBehavior] Gets or sets the MobileBehavior. .. !! processed by numpydoc !! .. py:property:: MobileBody :type: Optional[str] Gets the MobileBody. .. !! processed by numpydoc !! .. py:property:: MobileCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the MobileCoordinateSystem. .. !! processed by numpydoc !! .. py:property:: MobileLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the MobileLocation. .. !! processed by numpydoc !! .. py:property:: MobileNodeId :type: Optional[int] Returns Mobile Node Id. .. !! processed by numpydoc !! .. py:property:: MobilePinballRegion :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MobilePinballRegion. .. !! processed by numpydoc !! .. py:property:: MobileScopeLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the MobileScopeLocation. .. !! processed by numpydoc !! .. py:property:: MobileScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the MobileScopingMethod. .. !! processed by numpydoc !! .. py:property:: MobileXCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MobileXCoordinate. .. !! processed by numpydoc !! .. py:property:: MobileYCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MobileYCoordinate. .. !! processed by numpydoc !! .. py:property:: MobileZCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MobileZCoordinate. .. !! processed by numpydoc !! .. py:property:: NonLinearLongitudinalStiffness :type: Optional[Ansys.ACT.Mechanical.Fields.Field] Gets the non linear longitudinal stiffness defined in the tabular data. .. !! processed by numpydoc !! .. py:property:: PreloadType :type: Optional[Ansys.Mechanical.DataModel.Enums.SpringPreloadType] Gets or sets the PreloadType. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ReadOnly :type: Optional[bool] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: ReferenceAppliedBy :type: Optional[Ansys.Mechanical.DataModel.Enums.RemoteApplicationType] Gets or sets the ReferenceAppliedBy. .. !! processed by numpydoc !! .. py:property:: ReferenceBeamCoincidentLengthFactor :type: Optional[float] 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. .. !! processed by numpydoc !! .. py:property:: ReferenceBeamMaterial :type: Optional[str] Gets or sets the ReferenceBeamMaterial. .. !! processed by numpydoc !! .. py:property:: ReferenceBeamRadius :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ReferenceBeamRadius. .. !! processed by numpydoc !! .. py:property:: ReferenceBehavior :type: Optional[Ansys.Mechanical.DataModel.Enums.LoadBehavior] Gets or sets the ReferenceBehavior. .. !! processed by numpydoc !! .. py:property:: ReferenceBody :type: Optional[str] Gets the ReferenceBody. .. !! processed by numpydoc !! .. py:property:: ReferenceCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the ReferenceCoordinateSystem. .. !! processed by numpydoc !! .. py:property:: ReferenceLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the ReferenceLocation. .. !! processed by numpydoc !! .. py:property:: ReferenceNodeId :type: Optional[int] Returns Reference Node Id. .. !! processed by numpydoc !! .. py:property:: ReferencePinballRegion :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ReferencePinballRegion. .. !! processed by numpydoc !! .. py:property:: ReferenceScopeLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the ReferenceScopeLocation. .. !! processed by numpydoc !! .. py:property:: ReferenceScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ReferenceScopingMethod. .. !! processed by numpydoc !! .. py:property:: ReferenceXCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ReferenceXCoordinate. .. !! processed by numpydoc !! .. py:property:: ReferenceYCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ReferenceYCoordinate. .. !! processed by numpydoc !! .. py:property:: ReferenceZCoordinate :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ReferenceZCoordinate. .. !! processed by numpydoc !! .. py:property:: Rotation :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the Rotation. .. !! processed by numpydoc !! .. py:property:: Scope :type: Optional[Ansys.Mechanical.DataModel.Enums.SpringScopingType] Gets or sets the Scope. .. !! processed by numpydoc !! .. py:property:: SpringBehavior :type: Optional[Ansys.Mechanical.DataModel.Enums.SpringBehavior] Gets or sets the SpringBehavior. .. !! processed by numpydoc !! .. py:property:: SpringElementAPDLName :type: Optional[str] Gets or sets the SpringElementAPDLName. .. !! processed by numpydoc !! .. py:property:: SpringLength :type: Optional[Ansys.Core.Units.Quantity] Gets the SpringLength. .. !! processed by numpydoc !! .. py:property:: SpringType :type: Optional[Ansys.Mechanical.DataModel.Enums.SpringType] Gets or sets the SpringType. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: Torque :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the Torque. .. !! processed by numpydoc !! .. py:property:: TorsionalDamping :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the TorsionalDamping. .. !! processed by numpydoc !! .. py:property:: TorsionalStiffness :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the TorsionalStiffness. .. !! processed by numpydoc !! .. py:property:: Visible :type: Optional[bool] Gets or sets the Visible. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddCommandSnippet() -> Ansys.ACT.Automation.Mechanical.CommandSnippet Creates a new CommandSnippet .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PromoteToNamedSelection() -> Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection] Run the PromoteToNamedSelection action. .. !! processed by numpydoc !! .. py:method:: PromoteToRemotePoint() -> Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint] Run the PromoteToRemotePoint action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RenameBasedOnDefinition() -> None Run the RenameBasedOnDefinition action. .. !! processed by numpydoc !! .. vale on