ContactRegion#
- class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Connections.ContactRegion#
 Bases:
objectDefines a ContactRegion.
Overview#
Activate the current object.  | 
|
Creates a new CommandSnippet  | 
|
Creates a new child Comment.  | 
|
Creates a new child Figure.  | 
|
Creates a new child Image.  | 
|
Creates a new PythonCodeEventBased  | 
|
Copies all visible properties from this object to another.  | 
|
Creates a new parameter for a Property.  | 
|
Run the Delete action.  | 
|
Creates a copy of the current DataModelObject.  | 
|
Run the FlipContactTarget action.  | 
|
Gets the list of children, filtered by type.  | 
|
Gets the parameter corresponding to the given property.  | 
|
Run the GroupAllSimilarChildren action.  | 
|
Run the GroupSimilarObjects action.  | 
|
Run the LoadContactRegionSettings action.  | 
|
Run the PromoteToNamedSelection action.  | 
|
Run the PromoteToRemotePoint action.  | 
|
Get a property by its API name.  | 
|
Get a property by its unique name.  | 
|
Removes the parameter from the parameter set corresponding to the given property.  | 
|
Run the RenameBasedOnDefinition action.  | 
|
Run the ResetToDefault action.  | 
|
Run the SaveContactRegionSettings action.  | 
|
Run the SearchConnectionsForDuplicatePairs action.  | 
|
Run the SetDefaultAPDLNames action.  | 
Gets the AutomaticDetectionValue.  | 
|
Gets or sets the AutomaticElectricCapacitance.  | 
|
Gets or sets the AutomaticElectricConductance.  | 
|
Gets or sets the AutomaticNormalStiffness.  | 
|
Gets or sets the AutomaticThermalConductance.  | 
|
Gets or sets the BeamBeamDetection.  | 
|
Gets or sets the BeamBeamModel.  | 
|
Gets or sets the BeamMaterialName.  | 
|
Gets or sets the BeamRadius.  | 
|
Gets or sets the Behavior.  | 
|
Gets or sets the BondedMaximumOffset.  | 
|
Gets or sets the Breakable.  | 
|
Gets the list of children.  | 
|
Gets the list of associated comments.  | 
|
Gets or sets the ConstraintType.  | 
|
Gets or sets the ContactAPDLName.  | 
|
Gets the ContactBodies.  | 
|
Gets or sets the ContactCenterPoint.  | 
|
Gets or sets the ContactEndingPoint.  | 
|
Gets or sets the ContactFormulation.  | 
|
Gets or sets the ContactGeometryCorrection.  | 
|
Gets or sets the ContactOrientation.  | 
|
Gets or sets the ContactShellFace.  | 
|
Gets or sets the ContactStartingPoint.  | 
|
Gets or sets the ContactType.  | 
|
Gets or sets the ContinuousDistanceComputation.  | 
|
Gets the current DataModelObject's category.  | 
|
Gets or sets the DecayConstant.  | 
|
Gets or sets the DetectionMethod.  | 
|
Gets or sets the DisplayElementNormal.  | 
|
Gets or sets the DynamicCoefficient.  | 
|
Gets or sets the EdgeContactType.  | 
|
Gets or sets the ElasticSlipTolerance.  | 
|
Gets or sets the ElasticSlipToleranceFactor.  | 
|
Gets or sets the ElasticSlipToleranceValue.  | 
|
Gets or sets the ElectricCapacitanceValue.  | 
|
Gets or sets the ElectricConductanceValue.  | 
|
Gets the list of associated figures.  | 
|
Gets or sets the FlipContact.  | 
|
Gets or sets the FlipTarget.  | 
|
Gets or sets the FrictionCoefficient.  | 
|
Gets or sets the Handedness.  | 
|
Gets the list of associated images.  | 
|
Gets or sets the InitialClearance.  | 
|
Gets or sets the InitialClearanceFactor.  | 
|
Gets or sets the InitialClearanceValue.  | 
|
Gets or sets the InterfaceTreatment.  | 
|
Gets the internal object. For advanced usage only.  | 
|
Gets or sets the LineLineDetection.  | 
|
Gets or sets the Material.  | 
|
Gets or sets the MeanPitchDiameter.  | 
|
Gets or sets the NormalForceExponent.  | 
|
Gets or sets the NormalForceLimit.  | 
|
Gets or sets the NormalStiffnessFactor.  | 
|
Gets or sets the NormalStiffnessValue.  | 
|
Gets or sets the NormalStiffnessValueType.  | 
|
Gets or sets the NormalStressExponent.  | 
|
Gets or sets the NormalStressLimit.  | 
|
Gets or sets the PenetrationTolerance.  | 
|
Gets or sets the PenetrationToleranceFactor.  | 
|
Gets or sets the PenetrationToleranceValue.  | 
|
Gets or sets the PinballFactor.  | 
|
Gets or sets the PinballRadius.  | 
|
Gets or sets the PinballRegion.  | 
|
Gets or sets the PitchDistance.  | 
|
Gets or sets the PressureAtZeroPenetration.  | 
|
Gets or sets the PressureAtZeroPenetrationFactor.  | 
|
Gets or sets the PressureAtZeroPenetrationValue.  | 
|
Gets the list of properties for this object.  | 
|
Gets or sets the Protected.  | 
|
Gets or sets the RBDContactDetection.  | 
|
Gets or sets the ReadOnly.  | 
|
Gets or sets the RestitutionFactor.  | 
|
Gets the ScopeMode.  | 
|
Gets or sets the SharedSourceBody.  | 
|
Gets or sets the SharedSourceReverseNormalLocation.  | 
|
Gets or sets the SharedTargetBody.  | 
|
Gets or sets the SharedTargetReverseNormalLocation.  | 
|
Gets or sets the ShearForceExponent.  | 
|
Gets or sets the ShearForceLimit.  | 
|
Gets or sets the ShearStressExponent.  | 
|
Gets or sets the ShearStressLimit.  | 
|
Gets or sets the ShellThicknessEffect.  | 
|
Gets or sets the SmallSliding.  | 
|
Gets or sets the SourceLocation.  | 
|
Gets or sets the StabilizationDampingFactor.  | 
|
Gets or sets the Suppressed.  | 
|
Gets or sets the TargetAPDLName.  | 
|
Gets the TargetBodies.  | 
|
Gets or sets the TargetCenterPoint.  | 
|
Gets or sets the TargetEndingPoint.  | 
|
Gets or sets the TargetGeometryCorrection.  | 
|
Gets or sets the TargetLocation.  | 
|
Gets or sets the TargetOrientation.  | 
|
Gets or sets the TargetShellFace.  | 
|
Gets or sets the TargetStartingPoint.  | 
|
Gets or sets the ThermalConductanceValue.  | 
|
Gets or sets the ThreadAngle.  | 
|
Gets or sets the ThreadType.  | 
|
Gets or sets the TimeStepControls.  | 
|
Gets or sets the TrimContact.  | 
|
Gets or sets the TrimTolerance.  | 
|
Gets or sets the UpdateStiffness.  | 
|
Gets or sets the UserOffset.  | 
|
Gets the list of properties that are visible for this object.  | 
Property detail#
- property ContactRegion.AutomaticDetectionValue: Ansys.Core.Units.Quantity | None#
 Gets the AutomaticDetectionValue.
- property ContactRegion.AutomaticElectricCapacitance: bool | None#
 Gets or sets the AutomaticElectricCapacitance.
- property ContactRegion.AutomaticElectricConductance: bool | None#
 Gets or sets the AutomaticElectricConductance.
- property ContactRegion.AutomaticNormalStiffness: bool | None#
 Gets or sets the AutomaticNormalStiffness.
- property ContactRegion.AutomaticThermalConductance: bool | None#
 Gets or sets the AutomaticThermalConductance.
- property ContactRegion.BeamBeamDetection: Ansys.Mechanical.DataModel.Enums.BeamBeamContactDetectionType | None#
 Gets or sets the BeamBeamDetection.
- property ContactRegion.BeamBeamModel: Ansys.Mechanical.DataModel.Enums.BeamBeamModel | None#
 Gets or sets the BeamBeamModel.
- property ContactRegion.BeamRadius: Ansys.Core.Units.Quantity | None#
 Gets or sets the BeamRadius.
- property ContactRegion.Behavior: Ansys.Mechanical.DataModel.Enums.ContactBehavior | None#
 Gets or sets the Behavior.
- property ContactRegion.BondedMaximumOffset: Ansys.Core.Units.Quantity | None#
 Gets or sets the BondedMaximumOffset.
- property ContactRegion.Breakable: Ansys.Mechanical.DataModel.Enums.BondedBreakableType | None#
 Gets or sets the Breakable.
- property ContactRegion.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
 Gets the list of children.
- property ContactRegion.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#
 Gets the list of associated comments.
- property ContactRegion.ConstraintType: Ansys.Mechanical.DataModel.Enums.ContactConstraintType | None#
 Gets or sets the ConstraintType.
- property ContactRegion.ContactCenterPoint: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
 Gets or sets the ContactCenterPoint.
- property ContactRegion.ContactEndingPoint: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
 Gets or sets the ContactEndingPoint.
- property ContactRegion.ContactFormulation: Ansys.Mechanical.DataModel.Enums.ContactFormulation | None#
 Gets or sets the ContactFormulation.
- property ContactRegion.ContactGeometryCorrection: Ansys.Mechanical.DataModel.Enums.ContactCorrection | None#
 Gets or sets the ContactGeometryCorrection.
- property ContactRegion.ContactOrientation: Ansys.Mechanical.DataModel.Enums.ContactOrientation | None#
 Gets or sets the ContactOrientation.
- property ContactRegion.ContactShellFace: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None#
 Gets or sets the ContactShellFace.
- property ContactRegion.ContactStartingPoint: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
 Gets or sets the ContactStartingPoint.
- property ContactRegion.ContactType: Ansys.Mechanical.DataModel.Enums.ContactType | None#
 Gets or sets the ContactType.
- property ContactRegion.ContinuousDistanceComputation: Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled | None#
 Gets or sets the ContinuousDistanceComputation.
- property ContactRegion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#
 Gets the current DataModelObject's category.
- property ContactRegion.DetectionMethod: Ansys.Mechanical.DataModel.Enums.ContactDetectionPoint | None#
 Gets or sets the DetectionMethod.
- property ContactRegion.EdgeContactType: Ansys.Mechanical.DataModel.Enums.EdgeContactType | None#
 Gets or sets the EdgeContactType.
- property ContactRegion.ElasticSlipTolerance: Ansys.Mechanical.DataModel.Enums.ContactElasticSlipToleranceType | None#
 Gets or sets the ElasticSlipTolerance.
- property ContactRegion.ElasticSlipToleranceFactor: float | None#
 Gets or sets the ElasticSlipToleranceFactor.
- property ContactRegion.ElasticSlipToleranceValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the ElasticSlipToleranceValue.
- property ContactRegion.ElectricCapacitanceValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the ElectricCapacitanceValue.
- property ContactRegion.ElectricConductanceValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the ElectricConductanceValue.
- property ContactRegion.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#
 Gets the list of associated figures.
- property ContactRegion.Handedness: Ansys.Mechanical.DataModel.Enums.ContactBoltThreadHand | None#
 Gets or sets the Handedness.
- property ContactRegion.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#
 Gets the list of associated images.
- property ContactRegion.InitialClearance: Ansys.Mechanical.DataModel.Enums.InitialClearanceType | None#
 Gets or sets the InitialClearance.
- property ContactRegion.InitialClearanceFactor: float | None#
 Gets or sets the InitialClearanceFactor.
- property ContactRegion.InitialClearanceValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the InitialClearanceValue.
- property ContactRegion.InterfaceTreatment: Ansys.Mechanical.DataModel.Enums.ContactInitialEffect | None#
 Gets or sets the InterfaceTreatment.
- property ContactRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSContactRegionAuto | None#
 Gets the internal object. For advanced usage only.
- property ContactRegion.LineLineDetection: Ansys.Mechanical.DataModel.Enums.LineLineContactDetectionType | None#
 Gets or sets the LineLineDetection.
- property ContactRegion.MeanPitchDiameter: Ansys.Core.Units.Quantity | None#
 Gets or sets the MeanPitchDiameter.
- property ContactRegion.NormalForceLimit: Ansys.Core.Units.Quantity | None#
 Gets or sets the NormalForceLimit.
- property ContactRegion.NormalStiffnessValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the NormalStiffnessValue.
- property ContactRegion.NormalStiffnessValueType: Ansys.Mechanical.DataModel.Enums.ElementControlsNormalStiffnessType | None#
 Gets or sets the NormalStiffnessValueType.
- property ContactRegion.NormalStressLimit: Ansys.Core.Units.Quantity | None#
 Gets or sets the NormalStressLimit.
- property ContactRegion.PenetrationTolerance: Ansys.Mechanical.DataModel.Enums.ContactPenetrationToleranceType | None#
 Gets or sets the PenetrationTolerance.
- property ContactRegion.PenetrationToleranceFactor: float | None#
 Gets or sets the PenetrationToleranceFactor.
- property ContactRegion.PenetrationToleranceValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the PenetrationToleranceValue.
- property ContactRegion.PinballRadius: Ansys.Core.Units.Quantity | None#
 Gets or sets the PinballRadius.
- property ContactRegion.PinballRegion: Ansys.Mechanical.DataModel.Enums.ContactPinballType | None#
 Gets or sets the PinballRegion.
- property ContactRegion.PitchDistance: Ansys.Core.Units.Quantity | None#
 Gets or sets the PitchDistance.
- property ContactRegion.PressureAtZeroPenetration: Ansys.Mechanical.DataModel.Enums.PressureAtZeroPenetrationType | None#
 Gets or sets the PressureAtZeroPenetration.
- property ContactRegion.PressureAtZeroPenetrationFactor: float | None#
 Gets or sets the PressureAtZeroPenetrationFactor.
- property ContactRegion.PressureAtZeroPenetrationValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the PressureAtZeroPenetrationValue.
- property ContactRegion.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
 Gets the list of properties for this object.
- property ContactRegion.RBDContactDetection: Ansys.Mechanical.DataModel.Enums.DSRBDContactDetection | None#
 Gets or sets the RBDContactDetection.
- property ContactRegion.ScopeMode: Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None#
 Gets the ScopeMode.
Gets or sets the SharedSourceBody.
Gets or sets the SharedSourceReverseNormalLocation.
Gets or sets the SharedTargetBody.
Gets or sets the SharedTargetReverseNormalLocation.
- property ContactRegion.ShearForceLimit: Ansys.Core.Units.Quantity | None#
 Gets or sets the ShearForceLimit.
- property ContactRegion.ShearStressLimit: Ansys.Core.Units.Quantity | None#
 Gets or sets the ShearStressLimit.
- property ContactRegion.SmallSliding: Ansys.Mechanical.DataModel.Enums.ContactSmallSlidingType | None#
 Gets or sets the SmallSliding.
- property ContactRegion.SourceLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#
 Gets or sets the SourceLocation.
- property ContactRegion.StabilizationDampingFactor: float | None#
 Gets or sets the StabilizationDampingFactor.
- property ContactRegion.TargetCenterPoint: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
 Gets or sets the TargetCenterPoint.
- property ContactRegion.TargetEndingPoint: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
 Gets or sets the TargetEndingPoint.
- property ContactRegion.TargetGeometryCorrection: Ansys.Mechanical.DataModel.Enums.TargetCorrection | None#
 Gets or sets the TargetGeometryCorrection.
- property ContactRegion.TargetLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#
 Gets or sets the TargetLocation.
- property ContactRegion.TargetOrientation: Ansys.Mechanical.DataModel.Enums.TargetOrientation | None#
 Gets or sets the TargetOrientation.
- property ContactRegion.TargetShellFace: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None#
 Gets or sets the TargetShellFace.
- property ContactRegion.TargetStartingPoint: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
 Gets or sets the TargetStartingPoint.
- property ContactRegion.ThermalConductanceValue: Ansys.Core.Units.Quantity | None#
 Gets or sets the ThermalConductanceValue.
- property ContactRegion.ThreadAngle: Ansys.Core.Units.Quantity | None#
 Gets or sets the ThreadAngle.
- property ContactRegion.ThreadType: Ansys.Mechanical.DataModel.Enums.ContactBoltThreadType | None#
 Gets or sets the ThreadType.
- property ContactRegion.TimeStepControls: Ansys.Mechanical.DataModel.Enums.ContactTimeStepControls | None#
 Gets or sets the TimeStepControls.
- property ContactRegion.TrimContact: Ansys.Mechanical.DataModel.Enums.ContactTrimType | None#
 Gets or sets the TrimContact.
- property ContactRegion.TrimTolerance: Ansys.Core.Units.Quantity | None#
 Gets or sets the TrimTolerance.
- property ContactRegion.UpdateStiffness: Ansys.Mechanical.DataModel.Enums.UpdateContactStiffness | None#
 Gets or sets the UpdateStiffness.
- property ContactRegion.UserOffset: Ansys.Core.Units.Quantity | None#
 Gets or sets the UserOffset.
Method detail#
- ContactRegion.AddCommandSnippet() Ansys.ACT.Automation.Mechanical.CommandSnippet#
 Creates a new CommandSnippet
- ContactRegion.AddComment() Ansys.ACT.Automation.Mechanical.Comment#
 Creates a new child Comment.
- ContactRegion.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#
 Creates a new child Figure.
- ContactRegion.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.
- ContactRegion.AddPythonCodeEventBased() Ansys.ACT.Automation.Mechanical.PythonCodeEventBased#
 Creates a new PythonCodeEventBased
- ContactRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#
 Copies all visible properties from this object to another.
- ContactRegion.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#
 Creates a new parameter for a Property.
- ContactRegion.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#
 Creates a copy of the current DataModelObject.
- ContactRegion.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#
 Gets the list of children, filtered by type.
- ContactRegion.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#
 Gets the parameter corresponding to the given property.
- ContactRegion.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#
 Run the GroupSimilarObjects action.
- ContactRegion.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#
 Run the PromoteToNamedSelection action.
- ContactRegion.PromoteToRemotePoint() Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]#
 Run the PromoteToRemotePoint action.
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.
- ContactRegion.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#
 Get a property by its unique name.
- ContactRegion.RemoveParameter(propName: str) None#
 Removes the parameter from the parameter set corresponding to the given property.