Skip to main content

Mechanical scripting interface

OptimizationRegionBaseClass

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.OptimizationRegionBaseClass

Bases: object

Defines a OptimizationRegionBaseClass.

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.
ExclusionRegionLocation Gets or sets the ExclusionRegionLocation.
ExclusionScopingMethod Gets or sets the ExclusionScopingMethod.
InternalObject Gets the internal object. For advanced usage only.
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 OptimizationRegionBaseClass.Children : List[Ansys.ACT.Automation.Mechanical.DataModelObject] | None

Gets the list of children.

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

Gets or sets the ExclusionRegionLocation.

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

Gets or sets the ExclusionScopingMethod.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the MaxCumulatedDisplacementControl.

property OptimizationRegionBaseClass.MorphingTotalMoveLimit : float | None

Gets or sets the MorphingTotalMoveLimit.

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

Gets the list of properties for this object.

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

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

Method detail

OptimizationRegionBaseClass.Activate()

Activate the current object.

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

Copies all visible properties from this object to another.

OptimizationRegionBaseClass.CreateParameter(propName: str)

Creates a new parameter for a Property.

OptimizationRegionBaseClass.Delete()

Run the Delete action.

OptimizationRegionBaseClass.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

OptimizationRegionBaseClass.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

OptimizationRegionBaseClass.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

OptimizationRegionBaseClass.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

OptimizationRegionBaseClass.PropertyByName(name: str)

Get a property by its unique name.

OptimizationRegionBaseClass.RemoveParameter(propName: str)

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