`ContactMatchGroup`#

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

Bases: object

Defines a ContactMatchGroup.

Overview#

Methods

`Activate`	Activate the current object.
`AddComment`	Creates a new child Comment.
`AddContactRegion`	Creates a new child ContactRegion.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`AddInterStage`	Creates a new child InterStage.
`AddJoint`	Creates a new child Joint.
`AddSpotWeld`	Creates a new child SpotWeld.
`CopyTo`	Copies all visible properties from this object to another.
`CreateAutomaticConnections`	Run the CreateAutomaticConnections action.
`CreateParameter`	Creates a new parameter for a Property.
`Delete`	Run the Delete action.
`DeleteChildren`	Run the DeleteChildren 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.
`RenameBasedOnChildren`	Rename the Connection group based on the children.
`RepairOverlappingContactRegions`	Check for Overlapping Contact Regions. However, please note that this action does not result in any actual repair being performed.
`SearchConnectionsForDuplicatePairs`	Run the SearchConnectionsForDuplicatePairs action.
`SetDefaultAPDLNames`	Loop over all the valid contact regions and set the default APDL names.

Properties

`ActiveConnections`	Gets the ActiveConnections.
`AutomaticFixedJoints`	Gets or sets the AutomaticFixedJoints.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`ConnectionType`	Gets or sets the ConnectionType.
`Connections`	Gets the Connections.
`CylindricalFaces`	Gets or sets the CylindricalFaces.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`EdgeEdge`	Gets or sets the EdgeEdge.
`EdgeOverlapTolerance`	Gets or sets the EdgeOverlapTolerance.
`FaceAngleTolerance`	Gets or sets the FaceAngleTolerance.
`FaceEdge`	Gets or sets the FaceEdge.
`FaceFace`	Gets or sets the FaceFace.
`FaceFaceDetectionAngleTolerence`	Gets or sets the FaceFaceDetectionAngleTolerence.
`FaceOverlapTolerance`	Gets or sets the FaceOverlapTolerance.
`Figures`	Gets the list of associated figures.
`GroupBy`	Gets or sets the GroupBy.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Location`	Gets or sets the Location.
`MinimumDistancePercentage`	Gets or sets the MinimumDistancePercentage.
`MinimumDistanceValue`	Gets the MinimumDistanceValue.
`Priority`	Gets or sets the Priority.
`Properties`	Gets the list of properties for this object.
`ReadOnly`	Gets or sets the ReadOnly.
`RevoluteJoints`	Gets or sets the RevoluteJoints.
`SearchAcross`	Gets or sets the SearchAcross.
`Suppressed`	Gets or sets the Suppressed.
`ThicknessScaleFactor`	Gets or sets the ThicknessScaleFactor.
`ToleranceSlider`	Gets or sets the ToleranceSlider.
`ToleranceType`	Gets or sets the ToleranceType.
`ToleranceValue`	Gets or sets the ToleranceValue.
`UseRange`	Gets or sets the UseRange.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property ContactMatchGroup.ActiveConnections: int | None#: Gets the ActiveConnections.

property ContactMatchGroup.AutomaticFixedJoints: bool | None#: Gets or sets the AutomaticFixedJoints.

property ContactMatchGroup.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property ContactMatchGroup.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

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

property ContactMatchGroup.Connections: int | None#: Gets the Connections.

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

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

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

property ContactMatchGroup.EdgeOverlapTolerance: int | None#: Gets or sets the EdgeOverlapTolerance.

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

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

property ContactMatchGroup.FaceFace: bool | None#: Gets or sets the FaceFace.

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

property ContactMatchGroup.FaceOverlapTolerance: int | None#: Gets or sets the FaceOverlapTolerance.

property ContactMatchGroup.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

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

property ContactMatchGroup.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property ContactMatchGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSConnectionGroupAuto | None#: Gets the internal object. For advanced usage only.

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

property ContactMatchGroup.MinimumDistancePercentage: int | None#: Gets or sets the MinimumDistancePercentage.

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

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

property ContactMatchGroup.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property ContactMatchGroup.ReadOnly: bool | None#: Gets or sets the ReadOnly.

property ContactMatchGroup.RevoluteJoints: bool | None#: Gets or sets the RevoluteJoints.

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

property ContactMatchGroup.Suppressed: bool | None#: Gets or sets the Suppressed.

property ContactMatchGroup.ThicknessScaleFactor: float | None#: Gets or sets the ThicknessScaleFactor.

property ContactMatchGroup.ToleranceSlider: int | None#: Gets or sets the ToleranceSlider.

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

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

property ContactMatchGroup.UseRange: bool | None#: Gets or sets the UseRange.

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

Method detail#

ContactMatchGroup.Activate() → None#: Activate the current object.

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

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

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

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

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

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

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

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

ContactMatchGroup.CreateAutomaticConnections() → None#: Run the CreateAutomaticConnections action.

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

ContactMatchGroup.Delete() → None#: Run the Delete action.

ContactMatchGroup.DeleteChildren() → None#: Run the DeleteChildren action.

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

ContactMatchGroup.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

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

ContactMatchGroup.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

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

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

ContactMatchGroup.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

ContactMatchGroup.RenameBasedOnChildren() → bool#: Rename the Connection group based on the children.

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

ContactMatchGroup.SearchConnectionsForDuplicatePairs() → None#: Run the SearchConnectionsForDuplicatePairs action.

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