.. vale off :class:`OptimizationRegion` =========================== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.OptimizationRegion Bases: :py:obj:`object` Defines a OptimizationRegion. .. !! processed by numpydoc !! .. py:currentmodule:: OptimizationRegion Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~AddExclusionRegion` - Creates a new ExclusionRegion * - :py:attr:`~RenameBasedOnDefinition` - Run the RenameBasedOnDefinition action. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~InitialVolumeFraction` - Gets or sets the InitialVolumeFraction. * - :py:attr:`~MorphingTotalMoveLimit` - Gets or sets the MorphingTotalMoveLimit. * - :py:attr:`~LatticeMaxDensity` - Gets or sets the LatticeMaxDensity. * - :py:attr:`~LatticeMinDensity` - Gets or sets the LatticeMinDensity. * - :py:attr:`~MorphingIterationMoveLimit` - Gets or sets the MorphingIterationMoveLimit. * - :py:attr:`~PenaltyFactor` - Gets or sets the PenaltyFactor. * - :py:attr:`~MorphingTotalMeshDeformationTolerance` - Gets or sets the MorphingTotalMeshDeformationTolerance. * - :py:attr:`~ExclusionThickness` - Gets or sets the ExclusionThickness. * - :py:attr:`~InitializationHoleSize` - Gets or sets the InitializationHoleSize. * - :py:attr:`~LatticeSize` - Gets or sets the LatticeSize. * - :py:attr:`~BoundaryCondition` - Gets or sets the BoundaryCondition. * - :py:attr:`~ExclusionExtension` - Gets or sets the ExclusionExtension. * - :py:attr:`~HyperbolicProjection` - Gets or sets the HyperbolicProjection. * - :py:attr:`~InitializationModifierType` - Gets or sets the InitializationModifierType. * - :py:attr:`~LatticeType` - Gets or sets the LatticeType. * - :py:attr:`~MaxCumulatedDisplacementControl` - Gets or sets the MaxCumulatedDisplacementControl. * - :py:attr:`~MeshDeformationToleranceControl` - Gets or sets the MeshDeformationToleranceControl. * - :py:attr:`~OptimizationType` - Gets or sets the OptimizationType. * - :py:attr:`~ShapeMoveLimitControl` - Gets or sets the ShapeMoveLimitControl. * - :py:attr:`~DesignRegionLocation` - Gets or sets the DesignRegionLocation. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~ExclusionRegionLocation` - Gets or sets the ExclusionRegionLocation. * - :py:attr:`~ExclusionScopingMethod` - Gets or sets the ExclusionScopingMethod. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSOptimizationRegionAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: InitialVolumeFraction :no-index: :type: Optional[System.Double] Gets or sets the InitialVolumeFraction. .. !! processed by numpydoc !! .. py:property:: MorphingTotalMoveLimit :no-index: :type: Optional[System.Double] Gets or sets the MorphingTotalMoveLimit. .. !! processed by numpydoc !! .. py:property:: LatticeMaxDensity :no-index: :type: Optional[System.Double] Gets or sets the LatticeMaxDensity. .. !! processed by numpydoc !! .. py:property:: LatticeMinDensity :no-index: :type: Optional[System.Double] Gets or sets the LatticeMinDensity. .. !! processed by numpydoc !! .. py:property:: MorphingIterationMoveLimit :no-index: :type: Optional[System.Double] Gets or sets the MorphingIterationMoveLimit. .. !! processed by numpydoc !! .. py:property:: PenaltyFactor :no-index: :type: Optional[System.Double] Gets or sets the PenaltyFactor. .. !! processed by numpydoc !! .. py:property:: MorphingTotalMeshDeformationTolerance :no-index: :type: Optional[System.Double] Gets or sets the MorphingTotalMeshDeformationTolerance. .. !! processed by numpydoc !! .. py:property:: ExclusionThickness :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ExclusionThickness. .. !! processed by numpydoc !! .. py:property:: InitializationHoleSize :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the InitializationHoleSize. .. !! processed by numpydoc !! .. py:property:: LatticeSize :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the LatticeSize. .. !! processed by numpydoc !! .. py:property:: BoundaryCondition :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.BoundaryConditionType] Gets or sets the BoundaryCondition. .. !! processed by numpydoc !! .. py:property:: ExclusionExtension :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ExclusionType] Gets or sets the ExclusionExtension. .. !! processed by numpydoc !! .. py:property:: HyperbolicProjection :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.HyperbolicProjectionType] Gets or sets the HyperbolicProjection. .. !! processed by numpydoc !! .. py:property:: InitializationModifierType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.InitializationModifierType] Gets or sets the InitializationModifierType. .. !! processed by numpydoc !! .. py:property:: LatticeType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.LatticeType] Gets or sets the LatticeType. .. !! processed by numpydoc !! .. py:property:: MaxCumulatedDisplacementControl :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType] Gets or sets the MaxCumulatedDisplacementControl. .. !! processed by numpydoc !! .. py:property:: MeshDeformationToleranceControl :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType] Gets or sets the MeshDeformationToleranceControl. .. !! processed by numpydoc !! .. py:property:: OptimizationType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.OptimizationType] Gets or sets the OptimizationType. .. !! processed by numpydoc !! .. py:property:: ShapeMoveLimitControl :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType] Gets or sets the ShapeMoveLimitControl. .. !! processed by numpydoc !! .. py:property:: DesignRegionLocation :no-index: :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the DesignRegionLocation. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: ExclusionRegionLocation :no-index: :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the ExclusionRegionLocation. .. !! processed by numpydoc !! .. py:property:: ExclusionScopingMethod :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ExclusionScopingMethod. .. !! processed by numpydoc !! .. py:property:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.ACT.Automation.Mechanical.DataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: AddExclusionRegion() -> Ansys.ACT.Automation.Mechanical.ExclusionRegion :no-index: Creates a new ExclusionRegion .. !! processed by numpydoc !! .. py:method:: RenameBasedOnDefinition() -> System.Void :no-index: Run the RenameBasedOnDefinition action. .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) -> System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on