Skip to main content

Mechanical scripting interface

OptimizationRegion

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.OptimizationRegion

Bases: object

Defines a OptimizationRegion.

Overview

Methods

Name Description
Activate Activate the current object.
AddExclusionRegion Creates a new ExclusionRegion
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.
GetDefinition Gets the Worksheet Definition.
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

Name Description
BoundaryCondition Gets or sets the BoundaryCondition.
Children Gets the list of children.
DataModelObjectCategory Gets the current DataModelObject’s category.
DesignRegionLocation Gets or sets the DesignRegionLocation.
ExclusionExtension Gets or sets the ExclusionExtension.
ExclusionRegionLocation Gets or sets the ExclusionRegionLocation.
ExclusionScopingMethod Gets or sets the ExclusionScopingMethod.
ExclusionThickness Gets or sets the ExclusionThickness.
HyperbolicProjection Gets or sets the HyperbolicProjection.
InitialVolumeFraction Gets or sets the InitialVolumeFraction.
InitializationHoleSize Gets or sets the InitializationHoleSize.
InitializationModifierType Gets or sets the InitializationModifierType.
InternalObject Gets the internal object. For advanced usage only.
LatticeMaxDensity Gets or sets the LatticeMaxDensity.
LatticeMinDensity Gets or sets the LatticeMinDensity.
LatticeSize Gets or sets the LatticeSize.
LatticeType Gets or sets the LatticeType.
MaxCumulatedDisplacementControl Gets or sets the MaxCumulatedDisplacementControl.
MeshDeformationToleranceControl Gets or sets the MeshDeformationToleranceControl.
MorphingIterationMoveLimit Gets or sets the MorphingIterationMoveLimit.
MorphingTotalMeshDeformationTolerance Gets or sets the MorphingTotalMeshDeformationTolerance.
MorphingTotalMoveLimit Gets or sets the MorphingTotalMoveLimit.
OptimizationType Gets or sets the OptimizationType.
PenaltyFactor Gets or sets the PenaltyFactor.
Properties Gets the list of properties for this object.
ShapeMoveLimitControl Gets or sets the ShapeMoveLimitControl.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property OptimizationRegion.BoundaryCondition : Ansys.Mechanical.DataModel.Enums.BoundaryConditionType | None

Gets or sets the BoundaryCondition.

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

Gets the list of children.

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

Gets the current DataModelObject’s category.

property OptimizationRegion.DesignRegionLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the DesignRegionLocation.

property OptimizationRegion.ExclusionExtension : Ansys.Mechanical.DataModel.Enums.ExclusionType | None

Gets or sets the ExclusionExtension.

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

Gets or sets the ExclusionRegionLocation.

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

Gets or sets the ExclusionScopingMethod.

property OptimizationRegion.ExclusionThickness : Ansys.Core.Units.Quantity | None

Gets or sets the ExclusionThickness.

property OptimizationRegion.HyperbolicProjection : Ansys.Mechanical.DataModel.Enums.HyperbolicProjectionType | None

Gets or sets the HyperbolicProjection.

property OptimizationRegion.InitialVolumeFraction : float | None

Gets or sets the InitialVolumeFraction.

property OptimizationRegion.InitializationHoleSize : Ansys.Core.Units.Quantity | None

Gets or sets the InitializationHoleSize.

property OptimizationRegion.InitializationModifierType : Ansys.Mechanical.DataModel.Enums.InitializationModifierType | None

Gets or sets the InitializationModifierType.

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

Gets the internal object. For advanced usage only.

property OptimizationRegion.LatticeMaxDensity : float | None

Gets or sets the LatticeMaxDensity.

property OptimizationRegion.LatticeMinDensity : float | None

Gets or sets the LatticeMinDensity.

property OptimizationRegion.LatticeSize : Ansys.Core.Units.Quantity | None

Gets or sets the LatticeSize.

property OptimizationRegion.LatticeType : Ansys.Mechanical.DataModel.Enums.LatticeType | None

Gets or sets the LatticeType.

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

Gets or sets the MaxCumulatedDisplacementControl.

property OptimizationRegion.MeshDeformationToleranceControl : Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType | None

Gets or sets the MeshDeformationToleranceControl.

property OptimizationRegion.MorphingIterationMoveLimit : float | None

Gets or sets the MorphingIterationMoveLimit.

property OptimizationRegion.MorphingTotalMeshDeformationTolerance : float | None

Gets or sets the MorphingTotalMeshDeformationTolerance.

property OptimizationRegion.MorphingTotalMoveLimit : float | None

Gets or sets the MorphingTotalMoveLimit.

property OptimizationRegion.OptimizationType : Ansys.Mechanical.DataModel.Enums.OptimizationType | None

Gets or sets the OptimizationType.

property OptimizationRegion.PenaltyFactor : float | None

Gets or sets the PenaltyFactor.

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

Gets the list of properties for this object.

property OptimizationRegion.ShapeMoveLimitControl : Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType | None

Gets or sets the ShapeMoveLimitControl.

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

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

Method detail

OptimizationRegion.Activate()

Activate the current object.

OptimizationRegion.AddExclusionRegion()

Creates a new ExclusionRegion

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

Copies all visible properties from this object to another.

OptimizationRegion.CreateParameter(propName: str)

Creates a new parameter for a Property.

OptimizationRegion.Delete()

Run the Delete action.

OptimizationRegion.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

OptimizationRegion.GetDefinition()

Gets the Worksheet Definition.
This Definition is a list of OptimizationMaterial.

OptimizationRegion.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

OptimizationRegion.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

OptimizationRegion.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

OptimizationRegion.PropertyByName(name: str)

Get a property by its unique name.

OptimizationRegion.RemoveParameter(propName: str)

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

OptimizationRegion.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.