Skip to main content

Mechanical scripting interface

LocalDesignRestriction

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.LocalDesignRestriction

Bases: object

Defines a LocalDesignRestriction.

Overview

Methods

Name Description
Activate Activate the current object.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete 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.

Properties

Name Description
Children Gets the list of children.
DataModelObjectCategory Gets the current DataModelObject’s category.
ExclusionRegionLocation Gets or sets the ExclusionRegionLocation.
ExclusionScopingMethod Gets or sets the ExclusionScopingMethod.
InternalObject Gets the internal object. For advanced usage only.
LocalDesignRestrictionNature Gets or sets the LocalDesignRestrictionNature. This property enables you to specify geometry that the application does not optimize or specific faces from which the application does not move any nodes vertically with respect to the original face. Non-Optimizable option is the default.
MaxCumulatedDisplacementControl Gets or sets the MaxCumulatedDisplacementControl.
MorphingTotalMoveLimit Gets or sets the MorphingTotalMoveLimit.
Properties Gets the list of properties for this object.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property LocalDesignRestriction.Children : List[Ansys.ACT.Automation.Mechanical.DataModelObject] | None

Gets the list of children.

property LocalDesignRestriction.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property LocalDesignRestriction.ExclusionRegionLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ExclusionRegionLocation.

property LocalDesignRestriction.ExclusionScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ExclusionScopingMethod.

property LocalDesignRestriction.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSOptimizationRegionAuto | None

Gets the internal object. For advanced usage only.

property LocalDesignRestriction.LocalDesignRestrictionNature : Ansys.Mechanical.DataModel.Enums.TopoLocalDesignRestrictionNature | None

Gets or sets the LocalDesignRestrictionNature. This property enables you to specify geometry that the application does not optimize or specific faces from which the application does not move any nodes vertically with respect to the original face. Non-Optimizable option is the default.

property LocalDesignRestriction.MaxCumulatedDisplacementControl : Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType | None

Gets or sets the MaxCumulatedDisplacementControl.

property LocalDesignRestriction.MorphingTotalMoveLimit : float | None

Gets or sets the MorphingTotalMoveLimit.

property LocalDesignRestriction.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property LocalDesignRestriction.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

LocalDesignRestriction.Activate()

Activate the current object.

LocalDesignRestriction.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

LocalDesignRestriction.CreateParameter(propName: str)

Creates a new parameter for a Property.

LocalDesignRestriction.Delete()

Run the Delete action.

LocalDesignRestriction.Duplicate()

Creates a copy of the current DataModelObject.

LocalDesignRestriction.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

LocalDesignRestriction.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

LocalDesignRestriction.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

LocalDesignRestriction.GroupSimilarObjects()

Run the GroupSimilarObjects action.

LocalDesignRestriction.PropertyByAPIName(name: str)

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.

LocalDesignRestriction.PropertyByName(name: str)

Get a property by its unique name.

LocalDesignRestriction.RemoveParameter(propName: str)

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