## On this page

  

 

 # `DisplacementConstraint`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.DisplacementConstraint"></a>

#### *class* Ansys.ACT.Automation.Mechanical.DisplacementConstraint

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a DisplacementConstraint.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#DisplacementConstraint.Activate)Activate the current object.[`CopyTo`](#DisplacementConstraint.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#DisplacementConstraint.CreateParameter)Creates a new parameter for a Property.[`Delete`](#DisplacementConstraint.Delete)Run the Delete action.[`Duplicate`](#DisplacementConstraint.Duplicate)Creates a copy of the current DataModelObject.[`GetChildren`](#DisplacementConstraint.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#DisplacementConstraint.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#DisplacementConstraint.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#DisplacementConstraint.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#DisplacementConstraint.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#DisplacementConstraint.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#DisplacementConstraint.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`RenameBasedOnDefinition`](#DisplacementConstraint.RenameBasedOnDefinition)Run the RenameBasedOnDefinition action.### Properties

NameDescription[`Children`](#DisplacementConstraint.Children)Gets the list of children.[`DataModelObjectCategory`](#DisplacementConstraint.DataModelObjectCategory)Gets the current DataModelObject’s category.[`EnvironmentSelection`](#DisplacementConstraint.EnvironmentSelection)Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.[`InternalObject`](#DisplacementConstraint.InternalObject)Gets the internal object. For advanced usage only.[`Location`](#DisplacementConstraint.Location)Gets or sets the Location.[`Properties`](#DisplacementConstraint.Properties)Gets the list of properties for this object.[`ScopingMethod`](#DisplacementConstraint.ScopingMethod)Gets or sets the ScopingMethod.[`Suppressed`](#DisplacementConstraint.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#DisplacementConstraint.VisibleProperties)Gets the list of properties that are visible for this object.[`XComponentMax`](#DisplacementConstraint.XComponentMax)Gets or sets the XComponentMax.[`YComponentMax`](#DisplacementConstraint.YComponentMax)Gets or sets the YComponentMax.[`ZComponentMax`](#DisplacementConstraint.ZComponentMax)Gets or sets the ZComponentMax.<a id="property-detail"></a>

## Property detail

<a id="DisplacementConstraint.Children"></a>

### *property* DisplacementConstraint.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="DisplacementConstraint.DataModelObjectCategory"></a>

### *property* DisplacementConstraint.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="DisplacementConstraint.EnvironmentSelection"></a>

### *property* DisplacementConstraint.EnvironmentSelection *: Any | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

<a id="DisplacementConstraint.InternalObject"></a>

### *property* DisplacementConstraint.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="DisplacementConstraint.Location"></a>

### *property* DisplacementConstraint.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="DisplacementConstraint.Properties"></a>

### *property* DisplacementConstraint.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="DisplacementConstraint.ScopingMethod"></a>

### *property* DisplacementConstraint.ScopingMethod *: [Ansys.Mechanical.DataModel.Enums.GeometryDefineByType](../../../Mechanical/DataModel/Enums/GeometryDefineByType.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.GeometryDefineByType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ScopingMethod.

<a id="DisplacementConstraint.Suppressed"></a>

### *property* DisplacementConstraint.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="DisplacementConstraint.VisibleProperties"></a>

### *property* DisplacementConstraint.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="DisplacementConstraint.XComponentMax"></a>

### *property* DisplacementConstraint.XComponentMax *: [Ansys.ACT.Mechanical.Fields.Field](../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v242.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the XComponentMax.

<a id="DisplacementConstraint.YComponentMax"></a>

### *property* DisplacementConstraint.YComponentMax *: [Ansys.ACT.Mechanical.Fields.Field](../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v242.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the YComponentMax.

<a id="DisplacementConstraint.ZComponentMax"></a>

### *property* DisplacementConstraint.ZComponentMax *: [Ansys.ACT.Mechanical.Fields.Field](../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v242.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ZComponentMax.

<a id="method-detail"></a>

## Method detail

<a id="DisplacementConstraint.Activate"></a>

### DisplacementConstraint.Activate()

Activate the current object.

<a id="DisplacementConstraint.CopyTo"></a>

### DisplacementConstraint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="DisplacementConstraint.CreateParameter"></a>

### DisplacementConstraint.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="DisplacementConstraint.Delete"></a>

### DisplacementConstraint.Delete()

Run the Delete action.

<a id="DisplacementConstraint.Duplicate"></a>

### DisplacementConstraint.Duplicate()

Creates a copy of the current DataModelObject.

<a id="DisplacementConstraint.GetChildren"></a>

### DisplacementConstraint.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="DisplacementConstraint.GetParameter"></a>

### DisplacementConstraint.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="DisplacementConstraint.GroupAllSimilarChildren"></a>

### DisplacementConstraint.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="DisplacementConstraint.GroupSimilarObjects"></a>

### DisplacementConstraint.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="DisplacementConstraint.PropertyByAPIName"></a>

### DisplacementConstraint.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

```

<a id="DisplacementConstraint.PropertyByName"></a>

### DisplacementConstraint.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="DisplacementConstraint.RemoveParameter"></a>

### DisplacementConstraint.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Removes the parameter from the parameter set corresponding to the given property.

<a id="DisplacementConstraint.RenameBasedOnDefinition"></a>

### DisplacementConstraint.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.