`BoltPretension`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.BoltPretension#

Bases: object

Defines a BoltPretension.

Overview#

Methods

`PromoteToNamedSelection`	Run the PromoteToNamedSelection action.
`PromoteToCoordinateSystem`	Run the PromoteToCoordinateSystem action.
`GetDefineBy`	Gets the Bolt Define By value at a given solution step.
`SetDefineBy`	Sets the Bolt Define By value for a given solution step.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`DefineBy`	Gets a value indicating how the bolt pretension is defined at the analysis’ current step.
`InternalObject`	Gets the internal object. For advanced usage only.
`Increment`	Gets the Increment.
`Preadjustment`	Gets the Preadjustment.
`Preload`	Gets the Preload.
`Tolerance`	Gets or sets the Tolerance.
`CoordinateSystemBehavior`	Gets or sets the CoordinateSystemBehavior.
`Formulation`	Gets or sets the Formulation.
`SolveBehaviourType`	Gets or sets the SolveBehaviourType.
`Suppressed`	Gets or sets the Suppressed.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property BoltPretension.DefineBy: Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy | None: Gets a value indicating how the bolt pretension is defined at the analysis’ current step.

property BoltPretension.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPretensionBoltLoadAuto | None: Gets the internal object. For advanced usage only.

property BoltPretension.Increment: Ansys.ACT.Mechanical.Fields.Field | None: Gets the Increment.

property BoltPretension.Preadjustment: Ansys.ACT.Mechanical.Fields.Field | None: Gets the Preadjustment.

property BoltPretension.Preload: Ansys.ACT.Mechanical.Fields.Field | None: Gets the Preload.

property BoltPretension.Tolerance: Ansys.Core.Units.Quantity | None: Gets or sets the Tolerance.

property BoltPretension.CoordinateSystemBehavior: Ansys.Mechanical.DataModel.Enums.CoordinateSystemBehavior | None: Gets or sets the CoordinateSystemBehavior.

property BoltPretension.Formulation: Ansys.Mechanical.DataModel.Enums.FormulationType | None: Gets or sets the Formulation.

property BoltPretension.SolveBehaviourType: Ansys.Mechanical.DataModel.Enums.SolveBehaviourType | None: Gets or sets the SolveBehaviourType.

property BoltPretension.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property BoltPretension.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

property BoltPretension.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property BoltPretension.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property BoltPretension.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property BoltPretension.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property BoltPretension.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property BoltPretension.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property BoltPretension.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property BoltPretension.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property BoltPretension.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property BoltPretension.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

BoltPretension.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

BoltPretension.PromoteToCoordinateSystem() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.CoordinateSystem]: Run the PromoteToCoordinateSystem action.

BoltPretension.GetDefineBy(stepNumber: System.Int32) → Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy: Gets the Bolt Define By value at a given solution step.

BoltPretension.SetDefineBy(stepNumber: System.Int32, type: Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy) → System.Void: Sets the Bolt Define By value for a given solution step.

BoltPretension.Delete() → System.Void: Run the Delete action.

BoltPretension.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

BoltPretension.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

BoltPretension.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

BoltPretension.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

BoltPretension.AddImage(filePath: System.String) → 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.

BoltPretension.Activate() → System.Void: Activate the current object.

BoltPretension.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

BoltPretension.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

BoltPretension.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

BoltPretension.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

BoltPretension.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

BoltPretension.PropertyByAPIName(name: System.String) → 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.

BoltPretension.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

BoltPretension.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

BoltPretension.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.