PreContactTool
Last update: 14.01.2025
PreContactTool
class Ansys.ACT.Automation.Mechanical.PreContactTool
Bases: object
Defines a PreContactTool.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
AddFigure |
Creates a new child Figure. |
AddGap |
Creates a new ContactGap |
AddImage |
Creates a new child Image. |
AddInitialInformation |
Creates a new ContactDataTable |
AddPenetration |
Creates a new ContactPenetration |
AddStatus |
Creates a new ContactStatus |
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 PreContactTool.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property PreContactTool.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property PreContactTool.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property PreContactTool.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property PreContactTool.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property PreContactTool.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSContactToolAuto | None
Gets the internal object. For advanced usage only.
property PreContactTool.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property PreContactTool.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property PreContactTool.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None
Gets or sets the ScopingMethod.
property PreContactTool.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
PreContactTool.Activate()
Activate the current object.
PreContactTool.AddComment()
Creates a new child Comment.
PreContactTool.AddFigure()
Creates a new child Figure.
PreContactTool.AddGap()
Creates a new ContactGap
PreContactTool.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.
PreContactTool.AddInitialInformation()
Creates a new ContactDataTable
PreContactTool.AddPenetration()
Creates a new ContactPenetration
PreContactTool.AddStatus()
Creates a new ContactStatus
PreContactTool.ClearGeneratedData()
Run the ClearGeneratedData action.
PreContactTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
PreContactTool.CreateParameter(propName: str)
Creates a new parameter for a Property.
PreContactTool.Delete()
Run the Delete action.
PreContactTool.Duplicate()
Creates a copy of the current DataModelObject.
PreContactTool.EvaluateAllResults()
Run the EvaluateAllResults action.
PreContactTool.GenerateInitialContactResults()
Generate Initial Contact Results and Mesh Parts
PreContactTool.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
PreContactTool.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
PreContactTool.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
PreContactTool.GroupSimilarObjects()
Run the GroupSimilarObjects action.
PreContactTool.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.
PreContactTool.PropertyByName(name: str)
Get a property by its unique name.
PreContactTool.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.