Skip to main content

Mechanical scripting interface

ContactTool

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Connections.ContactTool

Bases: object

Defines a ContactTool.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
ClearGeneratedData Run the ClearGeneratedData action.
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.
EvaluateAllResults Run the EvaluateAllResults action.
GenerateInitialContactResults Generate Initial Contact Results and Mesh Parts
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
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.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Properties Gets the list of properties for this object.
ScopingMethod Gets or sets the ScopingMethod.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ContactTool.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSContactToolAuto | None

Gets the internal object. For advanced usage only.

property ContactTool.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

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

Gets the list of properties for this object.

property ContactTool.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

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

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

Method detail

ContactTool.Activate()

Activate the current object.

ContactTool.AddComment()

Creates a new child Comment.

ContactTool.AddFigure()

Creates a new child Figure.

ContactTool.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.

ContactTool.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ContactTool.CreateParameter(propName: str)

Creates a new parameter for a Property.

ContactTool.Delete()

Run the Delete action.

ContactTool.Duplicate()

Creates a copy of the current DataModelObject.

ContactTool.EvaluateAllResults()

Run the EvaluateAllResults action.

ContactTool.GenerateInitialContactResults()

Generate Initial Contact Results and Mesh Parts

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

Gets the list of children, filtered by type.

ContactTool.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ContactTool.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ContactTool.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ContactTool.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.

ContactTool.PropertyByName(name: str)

Get a property by its unique name.

ContactTool.RemoveParameter(propName: str)

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