`ContactMatchGroup`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.ContactMatchGroup#

Bases: object

Defines a ContactMatchGroup.

Overview#

Methods

`AddContactRegion`	Creates a new child ContactRegion.
`AddJoint`	Creates a new child Joint.
`SearchConnectionsForDuplicatePairs`	Run the SearchConnectionsForDuplicatePairs action.
`AddSpotWeld`	Creates a new child SpotWeld.
`AddInterStage`	Creates a new child InterStage.
`CreateAutomaticConnections`	Run the CreateAutomaticConnections action.
`DeleteChildren`	Run the DeleteChildren action.
`DeleteChildren`	Run the DeleteChildren action with optional verification dialog.
`RenameBasedOnChildren`	Rename the Connection group based on the children.
`SetDefaultAPDLNames`	Loop over all the valid contact regions and set the default APDL names.
`RepairOverlappingContactRegions`	Check for Overlapping Contact Regions. However, please note that this action does not result in any actual repair being performed.
`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

`InternalObject`	Gets the internal object. For advanced usage only.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`ConnectionType`	Gets or sets the ConnectionType.
`ActiveConnections`	Gets the ActiveConnections.
`Connections`	Gets the Connections.
`EdgeOverlapTolerance`	Gets or sets the EdgeOverlapTolerance.
`FaceOverlapTolerance`	Gets or sets the FaceOverlapTolerance.
`MinimumDistancePercentage`	Gets or sets the MinimumDistancePercentage.
`ThicknessScaleFactor`	Gets or sets the ThicknessScaleFactor.
`ToleranceSlider`	Gets or sets the ToleranceSlider.
`FaceFaceDetectionAngleTolerence`	Gets or sets the FaceFaceDetectionAngleTolerence.
`FaceAngleTolerance`	Gets or sets the FaceAngleTolerance.
`MinimumDistanceValue`	Gets the MinimumDistanceValue.
`ToleranceValue`	Gets or sets the ToleranceValue.
`CylindricalFaces`	Gets or sets the CylindricalFaces.
`Priority`	Gets or sets the Priority.
`GroupBy`	Gets or sets the GroupBy.
`SearchAcross`	Gets or sets the SearchAcross.
`ToleranceType`	Gets or sets the ToleranceType.
`EdgeEdge`	Gets or sets the EdgeEdge.
`FaceEdge`	Gets or sets the FaceEdge.
`AutomaticFixedJoints`	Gets or sets the AutomaticFixedJoints.
`RevoluteJoints`	Gets or sets the RevoluteJoints.
`Suppressed`	Gets or sets the Suppressed.
`FaceFace`	Gets or sets the FaceFace.
`UseRange`	Gets or sets the UseRange.
`Location`	Gets or sets the Location.
`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 ContactMatchGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSConnectionGroupAuto | None: Gets the internal object. For advanced usage only.

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

property ContactMatchGroup.ConnectionType: Ansys.Mechanical.DataModel.Enums.AutoDetectionType | None: Gets or sets the ConnectionType.

property ContactMatchGroup.ActiveConnections: System.UInt32 | None: Gets the ActiveConnections.

property ContactMatchGroup.Connections: System.UInt32 | None: Gets the Connections.

property ContactMatchGroup.EdgeOverlapTolerance: System.Int32 | None: Gets or sets the EdgeOverlapTolerance.

property ContactMatchGroup.FaceOverlapTolerance: System.Int32 | None: Gets or sets the FaceOverlapTolerance.

property ContactMatchGroup.MinimumDistancePercentage: System.Int32 | None: Gets or sets the MinimumDistancePercentage.

property ContactMatchGroup.ThicknessScaleFactor: System.Double | None: Gets or sets the ThicknessScaleFactor.

property ContactMatchGroup.ToleranceSlider: System.Int32 | None: Gets or sets the ToleranceSlider.

property ContactMatchGroup.FaceFaceDetectionAngleTolerence: Ansys.Core.Units.Quantity | None: Gets or sets the FaceFaceDetectionAngleTolerence.

property ContactMatchGroup.FaceAngleTolerance: Ansys.Core.Units.Quantity | None: Gets or sets the FaceAngleTolerance.

property ContactMatchGroup.MinimumDistanceValue: Ansys.Core.Units.Quantity | None: Gets the MinimumDistanceValue.

property ContactMatchGroup.ToleranceValue: Ansys.Core.Units.Quantity | None: Gets or sets the ToleranceValue.

property ContactMatchGroup.CylindricalFaces: Ansys.Mechanical.DataModel.Enums.CylindricalFacesOption | None: Gets or sets the CylindricalFaces.

property ContactMatchGroup.Priority: Ansys.Mechanical.DataModel.Enums.ContactFaceEdgePriority | None: Gets or sets the Priority.

property ContactMatchGroup.GroupBy: Ansys.Mechanical.DataModel.Enums.ContactGroupingType | None: Gets or sets the GroupBy.

property ContactMatchGroup.SearchAcross: Ansys.Mechanical.DataModel.Enums.ContactSearchingType | None: Gets or sets the SearchAcross.

property ContactMatchGroup.ToleranceType: Ansys.Mechanical.DataModel.Enums.ContactToleranceType | None: Gets or sets the ToleranceType.

property ContactMatchGroup.EdgeEdge: Ansys.Mechanical.DataModel.Enums.ContactEdgeEdgeOption | None: Gets or sets the EdgeEdge.

property ContactMatchGroup.FaceEdge: Ansys.Mechanical.DataModel.Enums.ContactFaceEdgeOption | None: Gets or sets the FaceEdge.

property ContactMatchGroup.AutomaticFixedJoints: System.Boolean | None: Gets or sets the AutomaticFixedJoints.

property ContactMatchGroup.RevoluteJoints: System.Boolean | None: Gets or sets the RevoluteJoints.

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

property ContactMatchGroup.FaceFace: System.Boolean | None: Gets or sets the FaceFace.

property ContactMatchGroup.UseRange: System.Boolean | None: Gets or sets the UseRange.

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

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

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

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

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

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

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

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

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

Method detail#

ContactMatchGroup.AddContactRegion() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion: Creates a new child ContactRegion.

ContactMatchGroup.AddJoint() → Ansys.ACT.Automation.Mechanical.Connections.Joint: Creates a new child Joint.

ContactMatchGroup.SearchConnectionsForDuplicatePairs() → System.Void: Run the SearchConnectionsForDuplicatePairs action.

ContactMatchGroup.AddSpotWeld() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion: Creates a new child SpotWeld.

ContactMatchGroup.AddInterStage() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion: Creates a new child InterStage.

ContactMatchGroup.CreateAutomaticConnections() → System.Void: Run the CreateAutomaticConnections action.

ContactMatchGroup.DeleteChildren() → System.Void: Run the DeleteChildren action.

ContactMatchGroup.DeleteChildren(b_Verify: System.Boolean) → System.Void: Run the DeleteChildren action with optional verification dialog.

ContactMatchGroup.RenameBasedOnChildren() → System.Boolean: Rename the Connection group based on the children.

ContactMatchGroup.SetDefaultAPDLNames() → System.Void: Loop over all the valid contact regions and set the default APDL names.

ContactMatchGroup.RepairOverlappingContactRegions() → System.Void: Check for Overlapping Contact Regions. However, please note that this action does not result in any actual repair being performed.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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