ExclusionRegion

class ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.ExclusionRegion

Bases: object

Overview

Methods

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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.

Properties

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	InternalObject property.
LocalDesignRestrictionNature	Gets or sets the LocalDesignRestrictionNature.
MaxCumulatedDisplacementControl	Gets or sets the MaxCumulatedDisplacementControl.
MorphingTotalMoveLimit	Gets or sets the MorphingTotalMoveLimit.
Properties	Gets the list of properties for this object.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the current DataModelObject's category.

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

Gets or sets the ExclusionRegionLocation.

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

Gets or sets the ExclusionScopingMethod.

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

InternalObject property.

property ExclusionRegion.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 ExclusionRegion.MaxCumulatedDisplacementControl: Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType | None

Gets or sets the MaxCumulatedDisplacementControl.

property ExclusionRegion.MorphingTotalMoveLimit: float | None

Gets or sets the MorphingTotalMoveLimit.

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

Gets the list of properties for this object.

property ExclusionRegion.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

ExclusionRegion.Activate() → None

Activate the current object.

ExclusionRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.ExclusionRegion) → None

Copies all visible properties from this object to another.
Override because of copy order of properties

ExclusionRegion.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

ExclusionRegion.Delete() → None

Run the Delete action.

ExclusionRegion.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ExclusionRegion.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

ExclusionRegion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

ExclusionRegion.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

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

ExclusionRegion.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

ExclusionRegion.RemoveParameter(propName: str) → None

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

ExclusionRegion.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.