.. vale off :class:`TopologyMultiDensity` ============================= .. py:class:: ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.Results.TopologyMultiDensity Bases: :py:obj:`object` Defines a TopologyMultiDensity. .. !! processed by numpydoc !! .. py:currentmodule:: TopologyMultiDensity Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~AddSmoothing` - Insert Smoothing Object * - :py:attr:`~ClearGeneratedData` - Clears the result. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~EvaluateAllResults` - Run the EvaluateAllResults action. * - :py:attr:`~ExportAnimation` - Run the ExportAnimation action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~RenameBasedOnDefinition` - Run the RenameBasedOnDefinition action. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~CalculateTimeHistory` - Gets or sets the CalculateTimeHistory. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~ExclusionsParticipation` - Gets or sets the ExclusionsParticipation. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~FinalMass` - Gets the FinalMass. * - :py:attr:`~FinalVolume` - Gets the FinalVolume. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~IterationNumber` - Gets the IterationNumber. * - :py:attr:`~IterationStep` - Gets or sets the IterationStep. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~Maximum` - Gets the Maximum. * - :py:attr:`~Minimum` - Gets the Minimum. * - :py:attr:`~OriginalMass` - Gets the OriginalMass. * - :py:attr:`~OriginalVolume` - Gets the OriginalVolume. * - :py:attr:`~PercentMassOfOriginal` - Gets the PercentMassOfOriginal. * - :py:attr:`~PercentVolumeOfOriginal` - Gets the PercentVolumeOfOriginal. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~Selection` - Gets or sets the Selection. * - :py:attr:`~ShowOptimizedRegion` - Gets or sets the ShowOptimizedRegion. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: CalculateTimeHistory :type: Optional[bool] Gets or sets the CalculateTimeHistory. .. !! processed by numpydoc !! .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: ExclusionsParticipation :type: Optional[bool] Gets or sets the ExclusionsParticipation. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: FinalMass :type: Optional[Ansys.Core.Units.Quantity] Gets the FinalMass. .. !! processed by numpydoc !! .. py:property:: FinalVolume :type: Optional[Ansys.Core.Units.Quantity] Gets the FinalVolume. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: IterationNumber :type: Optional[int] Gets the IterationNumber. .. !! processed by numpydoc !! .. py:property:: IterationStep :type: Optional[int] Gets or sets the IterationStep. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: Maximum :type: Optional[float] Gets the Maximum. .. !! processed by numpydoc !! .. py:property:: Minimum :type: Optional[float] Gets the Minimum. .. !! processed by numpydoc !! .. py:property:: OriginalMass :type: Optional[Ansys.Core.Units.Quantity] Gets the OriginalMass. .. !! processed by numpydoc !! .. py:property:: OriginalVolume :type: Optional[Ansys.Core.Units.Quantity] Gets the OriginalVolume. .. !! processed by numpydoc !! .. py:property:: PercentMassOfOriginal :type: Optional[float] Gets the PercentMassOfOriginal. .. !! processed by numpydoc !! .. py:property:: PercentVolumeOfOriginal :type: Optional[float] Gets the PercentVolumeOfOriginal. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: Selection :type: Optional[Ansys.ACT.Automation.Mechanical.OptimizationRegion] Gets or sets the Selection. .. !! processed by numpydoc !! .. py:property:: ShowOptimizedRegion :type: Optional[Ansys.Mechanical.DataModel.Enums.TopologyOptimizationResultShowType] Gets or sets the ShowOptimizedRegion. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window. .. !! processed by numpydoc !! .. py:method:: AddSmoothing() -> Ansys.ACT.Automation.Mechanical.Results.Smoothing Insert Smoothing Object .. !! processed by numpydoc !! .. py:method:: ClearGeneratedData() -> None Clears the result. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: EvaluateAllResults() -> None Run the EvaluateAllResults action. .. !! processed by numpydoc !! .. py:method:: ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) -> None Run the ExportAnimation action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. 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:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RenameBasedOnDefinition() -> None Run the RenameBasedOnDefinition action. .. !! processed by numpydoc !! .. vale on