Skip to main content

Mechanical scripting interface

BodyInteractions

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Connections.BodyInteractions

Bases: object

Defines a BodyInteractions.

Overview

Methods

Name Description
Activate Activate the current object.
AddBodyInteraction Creates a new child BodyInteraction.
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.
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.

Properties

Name Description
BodySelfContact Gets or sets the BodySelfContact.
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactDetection Gets or sets the ContactDetection.
DataModelObjectCategory Gets the current DataModelObject’s category.
EdgeOnEdgeContact Gets or sets the EdgeOnEdgeContact.
ElementSelfContact Gets or sets the ElementSelfContact.
Figures Gets the list of associated figures.
Formulation Gets or sets the Formulation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LimitingTimestepVelocity Gets or sets the LimitingTimestepVelocity.
ManualContactTreatment Gets or sets the ManualContactTreatment.
NodalShellThickness Gets or sets the NodalShellThickness.
PinballFactor Gets or sets the PinballFactor.
Properties Gets the list of properties for this object.
ShellThicknessFactor Gets or sets the ShellThicknessFactor.
SlidingContact Gets or sets the SlidingContact.
TimestepSafetyFactor Gets or sets the TimestepSafetyFactor.
Tolerance Gets or sets the Tolerance.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property BodyInteractions.BodySelfContact : Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled | None

Gets or sets the BodySelfContact.

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

Gets the list of children.

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

Gets the list of associated comments.

property BodyInteractions.ContactDetection : Ansys.Mechanical.DataModel.Enums.ContactDetection | None

Gets or sets the ContactDetection.

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

Gets the current DataModelObject’s category.

property BodyInteractions.EdgeOnEdgeContact : bool | None

Gets or sets the EdgeOnEdgeContact.

property BodyInteractions.ElementSelfContact : Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled | None

Gets or sets the ElementSelfContact.

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

Gets the list of associated figures.

property BodyInteractions.Formulation : Ansys.Mechanical.DataModel.Enums.BodyInteractionFormulation | None

Gets or sets the Formulation.

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

Gets the list of associated images.

property BodyInteractions.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSBodyInteractionGroupAuto | None

Gets the internal object. For advanced usage only.

property BodyInteractions.LimitingTimestepVelocity : Ansys.Core.Units.Quantity | None

Gets or sets the LimitingTimestepVelocity.

property BodyInteractions.ManualContactTreatment : Ansys.Mechanical.DataModel.Enums.ManualContactTreatmentType | None

Gets or sets the ManualContactTreatment.

property BodyInteractions.NodalShellThickness : Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled | None

Gets or sets the NodalShellThickness.

property BodyInteractions.PinballFactor : float | None

Gets or sets the PinballFactor.

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

Gets the list of properties for this object.

property BodyInteractions.ShellThicknessFactor : float | None

Gets or sets the ShellThicknessFactor.

property BodyInteractions.SlidingContact : Ansys.Mechanical.DataModel.Enums.SlidingContactType | None

Gets or sets the SlidingContact.

property BodyInteractions.TimestepSafetyFactor : float | None

Gets or sets the TimestepSafetyFactor.

property BodyInteractions.Tolerance : float | None

Gets or sets the Tolerance.

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

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

Method detail

BodyInteractions.Activate()

Activate the current object.

BodyInteractions.AddBodyInteraction()

Creates a new child BodyInteraction.

BodyInteractions.AddComment()

Creates a new child Comment.

BodyInteractions.AddFigure()

Creates a new child Figure.

BodyInteractions.AddImage(filePath: str)

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.

BodyInteractions.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

BodyInteractions.CreateParameter(propName: str)

Creates a new parameter for a Property.

BodyInteractions.Delete()

Run the Delete action.

BodyInteractions.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

BodyInteractions.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

BodyInteractions.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

BodyInteractions.GroupSimilarObjects()

Run the GroupSimilarObjects action.

BodyInteractions.PropertyByAPIName(name: str)

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.

BodyInteractions.PropertyByName(name: str)

Get a property by its unique name.

BodyInteractions.RemoveParameter(propName: str)

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