BoltPretension#

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

Bases: object

Defines a BoltPretension.

Overview#

Activate

Activate the current object.

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.

GetDefineBy

Gets the Bolt Define By value at a given solution step.

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PromoteToCoordinateSystem

Run the PromoteToCoordinateSystem action.

PromoteToNamedSelection

Run the PromoteToNamedSelection 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.

SetDefineBy

Sets the Bolt Define By value for a given solution step.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the CoordinateSystem.

CoordinateSystemBehavior

Gets or sets the CoordinateSystemBehavior.

DataModelObjectCategory

Gets the current DataModelObject's category.

DefineBy

Gets a value indicating how the bolt pretension is defined at the analysis' current step.

Figures

Gets the list of associated figures.

Formulation

Gets or sets the Formulation.

Images

Gets the list of associated images.

Increment

Gets the Increment.

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

Preadjustment

Gets the Preadjustment.

Preload

Gets the Preload.

Properties

Gets the list of properties for this object.

ReadOnly

Gets or sets the ReadOnly.

SolveBehaviourType

Gets or sets the SolveBehaviourType.

Suppressed

Gets or sets the Suppressed.

Tolerance

Gets or sets the Tolerance.

VisibleProperties

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

Property detail#

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

Gets the list of children.

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

Gets the list of associated comments.

property BoltPretension.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystem.

property BoltPretension.CoordinateSystemBehavior: Ansys.Mechanical.DataModel.Enums.CoordinateSystemBehavior | None#

Gets or sets the CoordinateSystemBehavior.

property BoltPretension.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

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.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#

Gets the list of associated figures.

property BoltPretension.Formulation: Ansys.Mechanical.DataModel.Enums.FormulationType | None#

Gets or sets the Formulation.

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

Gets the list of associated images.

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

Gets the Increment.

property BoltPretension.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPretensionBoltLoadAuto | None#

Gets the internal object. For advanced usage only.

property BoltPretension.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

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.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property BoltPretension.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property BoltPretension.SolveBehaviourType: Ansys.Mechanical.DataModel.Enums.SolveBehaviourType | None#

Gets or sets the SolveBehaviourType.

property BoltPretension.Suppressed: bool | None#

Gets or sets the Suppressed.

property BoltPretension.Tolerance: Ansys.Core.Units.Quantity | None#

Gets or sets the Tolerance.

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

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

Method detail#

BoltPretension.Activate() None#

Activate the current object.

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: 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.
BoltPretension.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

BoltPretension.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

BoltPretension.Delete() None#

Run the Delete action.

BoltPretension.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

BoltPretension.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

BoltPretension.GetDefineBy(stepNumber: int) Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy#

Gets the Bolt Define By value at a given solution step.

BoltPretension.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

BoltPretension.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

BoltPretension.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

BoltPretension.PromoteToCoordinateSystem() Iterable[Ansys.ACT.Automation.Mechanical.CoordinateSystem]#

Run the PromoteToCoordinateSystem action.

BoltPretension.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

BoltPretension.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.
BoltPretension.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

BoltPretension.RemoveParameter(propName: str) None#

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

BoltPretension.SetDefineBy(stepNumber: int, type: Ansys.Mechanical.DataModel.Enums.BoltLoadDefineBy) None#

Sets the Bolt Define By value for a given solution step.