OptimizationRegion

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.OptimizationRegion(internalObject: Any)

Bases: object

Defines a OptimizationRegion.

Overview

Methods

Activate	Activate the current object.
AddExclusionRegion	Obsolete. Use AddLocalDesignRestriction.
AddLocalDesignRestriction	Creates a new LocalDesignRestriction
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDefinition	Gets the Worksheet Definition.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BoundaryCondition	Gets or sets the BoundaryCondition.
Children	Gets the list of children.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
DesignRegionLocation	Gets or sets the DesignRegionLocation.
DistortionControl
ExclusionExtension	Gets or sets the ExclusionExtension.
ExclusionRegionLocation	Gets or sets the ExclusionRegionLocation.
ExclusionScopingMethod	Gets or sets the ExclusionScopingMethod.
ExclusionThickness	Gets or sets the ExclusionThickness.
GroupingFolder	GroupingFolder property.
HyperbolicProjection	Gets or sets the HyperbolicProjection.
IconName	IconName property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OptimizationType	Gets or sets the OptimizationType.
Parent	Parent property.
PenaltyFactor	Gets or sets the PenaltyFactor.
Properties	Gets the list of properties for this object.
ShapeMoveLimitControl	Gets or sets the ShapeMoveLimitControl.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property OptimizationRegion.AttachedRefs: List[int] | None

AttachedRefs property.

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.ClsId: int | None

ClsId property.

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.DistortionControl: bool | None

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

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

Gets or sets the HyperbolicProjection.

property OptimizationRegion.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property OptimizationRegion.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property OptimizationRegion.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

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

Gets or sets the OptimizationType.

property OptimizationRegion.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

OptimizationRegion.AddExclusionRegion() → Ansys.ACT.Automation.Mechanical.LocalDesignRestriction

Obsolete. Use AddLocalDesignRestriction.

OptimizationRegion.AddLocalDesignRestriction() → Ansys.ACT.Automation.Mechanical.LocalDesignRestriction

Creates a new LocalDesignRestriction

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

Copies all visible properties from this object to another.

OptimizationRegion.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

OptimizationRegion.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

OptimizationRegion.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

OptimizationRegion.GetAPIName(dispId: int) → str

Property name bound to dispId.

OptimizationRegion.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

OptimizationRegion.GetDefinition() → Ansys.ACT.Automation.Mechanical.MaterialsOptimizationDefinition

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

OptimizationRegion.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

OptimizationRegion.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

OptimizationRegion.GetHashCode() → int

GetHashCode method.

OptimizationRegion.GetIconFile() → System.Byte

GetIconFile method.

OptimizationRegion.GetLifetimeService() → Any

GetLifetimeService method.

OptimizationRegion.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

OptimizationRegion.GetPath() → str

GetPath method.

OptimizationRegion.GetPropertyName(dispId: int) → str

GetPropertyName method.

OptimizationRegion.GetPropertyValue(name: str) → Any

GetPropertyValue method.

OptimizationRegion.GetType() → type

GetType method.

OptimizationRegion.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

OptimizationRegion.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

OptimizationRegion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

OptimizationRegion.InitializeLifetimeService() → Any

InitializeLifetimeService method.

OptimizationRegion.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

OptimizationRegion.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

OptimizationRegion.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

OptimizationRegion.RemoveParameter(propName: str) → None

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

OptimizationRegion.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

OptimizationRegion.ToString() → str

ToString method.