.. vale off :class:`ContactMatchGroup` ========================== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.ContactMatchGroup Bases: :py:obj:`object` Defines a ContactMatchGroup. .. !! processed by numpydoc !! .. py:currentmodule:: ContactMatchGroup Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~AddContactRegion` - Creates a new child ContactRegion. * - :py:attr:`~AddJoint` - Creates a new child Joint. * - :py:attr:`~SearchConnectionsForDuplicatePairs` - Run the SearchConnectionsForDuplicatePairs action. * - :py:attr:`~AddSpotWeld` - Creates a new child SpotWeld. * - :py:attr:`~AddInterStage` - Creates a new child InterStage. * - :py:attr:`~CreateAutomaticConnections` - Run the CreateAutomaticConnections action. * - :py:attr:`~DeleteChildren` - Run the DeleteChildren action. * - :py:attr:`~DeleteChildren` - Run the DeleteChildren action with optional verification dialog. * - :py:attr:`~RenameBasedOnChildren` - Rename the Connection group based on the children. * - :py:attr:`~SetDefaultAPDLNames` - Loop over all the valid contact regions and set the default APDL names. * - :py:attr:`~RepairOverlappingContactRegions` - Run the RepairOverlappingContactRegions action. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~ConnectionType` - Gets or sets the ConnectionType. * - :py:attr:`~ActiveConnections` - Gets the ActiveConnections. * - :py:attr:`~Connections` - Gets the Connections. * - :py:attr:`~EdgeOverlapTolerance` - Gets or sets the EdgeOverlapTolerance. * - :py:attr:`~FaceOverlapTolerance` - Gets or sets the FaceOverlapTolerance. * - :py:attr:`~MinimumDistancePercentage` - Gets or sets the MinimumDistancePercentage. * - :py:attr:`~ThicknessScaleFactor` - Gets or sets the ThicknessScaleFactor. * - :py:attr:`~ToleranceSlider` - Gets or sets the ToleranceSlider. * - :py:attr:`~FaceFaceDetectionAngleTolerence` - Gets or sets the FaceFaceDetectionAngleTolerence. * - :py:attr:`~FaceAngleTolerance` - Gets or sets the FaceAngleTolerance. * - :py:attr:`~MinimumDistanceValue` - Gets the MinimumDistanceValue. * - :py:attr:`~ToleranceValue` - Gets or sets the ToleranceValue. * - :py:attr:`~CylindricalFaces` - Gets or sets the CylindricalFaces. * - :py:attr:`~Priority` - Gets or sets the Priority. * - :py:attr:`~GroupBy` - Gets or sets the GroupBy. * - :py:attr:`~SearchAcross` - Gets or sets the SearchAcross. * - :py:attr:`~ToleranceType` - Gets or sets the ToleranceType. * - :py:attr:`~EdgeEdge` - Gets or sets the EdgeEdge. * - :py:attr:`~FaceEdge` - Gets or sets the FaceEdge. * - :py:attr:`~AutomaticFixedJoints` - Gets or sets the AutomaticFixedJoints. * - :py:attr:`~RevoluteJoints` - Gets or sets the RevoluteJoints. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~FaceFace` - Gets or sets the FaceFace. * - :py:attr:`~UseRange` - Gets or sets the UseRange. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSConnectionGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: ConnectionType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.AutoDetectionType] Gets or sets the ConnectionType. .. !! processed by numpydoc !! .. py:property:: ActiveConnections :no-index: :type: Optional[System.UInt32] Gets the ActiveConnections. .. !! processed by numpydoc !! .. py:property:: Connections :no-index: :type: Optional[System.UInt32] Gets the Connections. .. !! processed by numpydoc !! .. py:property:: EdgeOverlapTolerance :no-index: :type: Optional[System.Int32] Gets or sets the EdgeOverlapTolerance. .. !! processed by numpydoc !! .. py:property:: FaceOverlapTolerance :no-index: :type: Optional[System.Int32] Gets or sets the FaceOverlapTolerance. .. !! processed by numpydoc !! .. py:property:: MinimumDistancePercentage :no-index: :type: Optional[System.Int32] Gets or sets the MinimumDistancePercentage. .. !! processed by numpydoc !! .. py:property:: ThicknessScaleFactor :no-index: :type: Optional[System.Double] Gets or sets the ThicknessScaleFactor. .. !! processed by numpydoc !! .. py:property:: ToleranceSlider :no-index: :type: Optional[System.Int32] Gets or sets the ToleranceSlider. .. !! processed by numpydoc !! .. py:property:: FaceFaceDetectionAngleTolerence :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the FaceFaceDetectionAngleTolerence. .. !! processed by numpydoc !! .. py:property:: FaceAngleTolerance :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the FaceAngleTolerance. .. !! processed by numpydoc !! .. py:property:: MinimumDistanceValue :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the MinimumDistanceValue. .. !! processed by numpydoc !! .. py:property:: ToleranceValue :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ToleranceValue. .. !! processed by numpydoc !! .. py:property:: CylindricalFaces :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.CylindricalFacesOption] Gets or sets the CylindricalFaces. .. !! processed by numpydoc !! .. py:property:: Priority :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactFaceEdgePriority] Gets or sets the Priority. .. !! processed by numpydoc !! .. py:property:: GroupBy :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactGroupingType] Gets or sets the GroupBy. .. !! processed by numpydoc !! .. py:property:: SearchAcross :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactSearchingType] Gets or sets the SearchAcross. .. !! processed by numpydoc !! .. py:property:: ToleranceType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactToleranceType] Gets or sets the ToleranceType. .. !! processed by numpydoc !! .. py:property:: EdgeEdge :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactEdgeEdgeOption] Gets or sets the EdgeEdge. .. !! processed by numpydoc !! .. py:property:: FaceEdge :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactFaceEdgeOption] Gets or sets the FaceEdge. .. !! processed by numpydoc !! .. py:property:: AutomaticFixedJoints :no-index: :type: Optional[System.Boolean] Gets or sets the AutomaticFixedJoints. .. !! processed by numpydoc !! .. py:property:: RevoluteJoints :no-index: :type: Optional[System.Boolean] Gets or sets the RevoluteJoints. .. !! processed by numpydoc !! .. py:property:: Suppressed :no-index: :type: Optional[System.Boolean] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: FaceFace :no-index: :type: Optional[System.Boolean] Gets or sets the FaceFace. .. !! processed by numpydoc !! .. py:property:: UseRange :no-index: :type: Optional[System.Boolean] Gets or sets the UseRange. .. !! processed by numpydoc !! .. py:property:: Location :no-index: :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Figures :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: ReadOnly :no-index: :type: Optional[System.Boolean] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: AddContactRegion() -> Ansys.ACT.Automation.Mechanical.Connections.ContactRegion :no-index: Creates a new child ContactRegion. .. !! processed by numpydoc !! .. py:method:: AddJoint() -> Ansys.ACT.Automation.Mechanical.Connections.Joint :no-index: Creates a new child Joint. .. !! processed by numpydoc !! .. py:method:: SearchConnectionsForDuplicatePairs() -> System.Void :no-index: Run the SearchConnectionsForDuplicatePairs action. .. !! processed by numpydoc !! .. py:method:: AddSpotWeld() -> Ansys.ACT.Automation.Mechanical.Connections.ContactRegion :no-index: Creates a new child SpotWeld. .. !! processed by numpydoc !! .. py:method:: AddInterStage() -> Ansys.ACT.Automation.Mechanical.Connections.ContactRegion :no-index: Creates a new child InterStage. .. !! processed by numpydoc !! .. py:method:: CreateAutomaticConnections() -> System.Void :no-index: Run the CreateAutomaticConnections action. .. !! processed by numpydoc !! .. py:method:: DeleteChildren() -> System.Void :no-index: Run the DeleteChildren action. .. !! processed by numpydoc !! .. py:method:: DeleteChildren(b_Verify: System.Boolean) -> System.Void :no-index: Run the DeleteChildren action with optional verification dialog. .. !! processed by numpydoc !! .. py:method:: RenameBasedOnChildren() -> System.Boolean :no-index: Rename the Connection group based on the children. .. !! processed by numpydoc !! .. py:method:: SetDefaultAPDLNames() -> System.Void :no-index: Loop over all the valid contact regions and set the default APDL names. .. !! processed by numpydoc !! .. py:method:: RepairOverlappingContactRegions() -> System.Void :no-index: Run the RepairOverlappingContactRegions action. .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: 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] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment :no-index: Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure :no-index: Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: System.String) -> Ansys.ACT.Automation.Mechanical.Image :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on