.. vale off :class:`Sizing` =============== .. py:class:: ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.MeshControls.Sizing Bases: :py:obj:`object` Defines a Sizing. .. !! processed by numpydoc !! .. py:currentmodule:: Sizing 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:`~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:`~GenerateMesh` - Generate the Mesh. * - :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:`~Active` - Gets the Active. * - :py:attr:`~Behavior` - Gets or sets the Behavior. * - :py:attr:`~BiasFactor` - Gets or sets the BiasFactor. * - :py:attr:`~BiasGrowthRate` - Gets or sets the BiasGrowthRate. * - :py:attr:`~BiasOption` - Gets or sets the BiasOption. * - :py:attr:`~BiasType` - Gets or sets the BiasType. * - :py:attr:`~BlendToNeighbors` - Gets or sets whether to automatically blend sizes away from the scoped edges. Default: True * - :py:attr:`~BodyOfInfluence` - Gets the BodyOfInfluence. * - :py:attr:`~CaptureCurvature` - Gets or sets the CaptureCurvature. * - :py:attr:`~CaptureProximity` - Gets or sets the CaptureProximity. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~CurvatureNormalAngle` - Gets or sets the CurvatureNormalAngle. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~DefeatureSize` - Gets or sets the DefeatureSize. * - :py:attr:`~ElementSize` - Gets or sets the ElementSize. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~GrowthRate` - Gets or sets the GrowthRate. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~LocalMinimumSize` - Gets or sets the LocalMinimumSize. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~NamedSelection` - Gets or sets the NamedSelection. * - :py:attr:`~NumberOfDivisions` - Gets or sets the NumberOfDivisions. * - :py:attr:`~OriginX` - Gets the OriginX. * - :py:attr:`~OriginY` - Gets the OriginY. * - :py:attr:`~OriginZ` - Gets the OriginZ. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ProximityGapFactor` - Gets or sets the ProximityGapFactor. * - :py:attr:`~ProximityMinimumSize` - Gets or sets the ProximityMinimumSize. * - :py:attr:`~ProximitySizeSources` - Gets or sets the ProximitySizeSources. * - :py:attr:`~ReverseBias` - Gets or sets the ReverseBias. * - :py:attr:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~SphereCenter` - Gets or sets the SphereCenter. * - :py:attr:`~SphereRadius` - Gets or sets the SphereRadius. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~Type` - Gets or sets the Type. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: Active :type: Optional[bool] Gets the Active. .. !! processed by numpydoc !! .. py:property:: Behavior :type: Optional[Ansys.Mechanical.DataModel.Enums.SizingBehavior] Gets or sets the Behavior. .. !! processed by numpydoc !! .. py:property:: BiasFactor :type: Optional[float] Gets or sets the BiasFactor. .. !! processed by numpydoc !! .. py:property:: BiasGrowthRate :type: Optional[float] Gets or sets the BiasGrowthRate. .. !! processed by numpydoc !! .. py:property:: BiasOption :type: Optional[Ansys.Mechanical.DataModel.Enums.BiasOptionType] Gets or sets the BiasOption. .. !! processed by numpydoc !! .. py:property:: BiasType :type: Optional[Ansys.Mechanical.DataModel.Enums.BiasType] Gets or sets the BiasType. .. !! processed by numpydoc !! .. py:property:: BlendToNeighbors :type: Optional[bool] Gets or sets whether to automatically blend sizes away from the scoped edges. Default: True .. !! processed by numpydoc !! .. py:property:: BodyOfInfluence :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets the BodyOfInfluence. .. !! processed by numpydoc !! .. py:property:: CaptureCurvature :type: Optional[bool] Gets or sets the CaptureCurvature. .. !! processed by numpydoc !! .. py:property:: CaptureProximity :type: Optional[bool] Gets or sets the CaptureProximity. .. !! 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:: CurvatureNormalAngle :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the CurvatureNormalAngle. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: DefeatureSize :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the DefeatureSize. .. !! processed by numpydoc !! .. py:property:: ElementSize :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ElementSize. .. !! 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:: GrowthRate :type: Optional[float] Gets or sets the GrowthRate. .. !! 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.IDSMeshControlAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: LocalMinimumSize :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the LocalMinimumSize. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: NamedSelection :type: Optional[Ansys.ACT.Automation.Mechanical.NamedSelection] Gets or sets the NamedSelection. .. !! processed by numpydoc !! .. py:property:: NumberOfDivisions :type: Optional[int] Gets or sets the NumberOfDivisions. .. !! processed by numpydoc !! .. py:property:: OriginX :type: Optional[Ansys.Core.Units.Quantity] Gets the OriginX. .. !! processed by numpydoc !! .. py:property:: OriginY :type: Optional[Ansys.Core.Units.Quantity] Gets the OriginY. .. !! processed by numpydoc !! .. py:property:: OriginZ :type: Optional[Ansys.Core.Units.Quantity] Gets the OriginZ. .. !! 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:: ProximityGapFactor :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ProximityGapFactor. .. !! processed by numpydoc !! .. py:property:: ProximityMinimumSize :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ProximityMinimumSize. .. !! processed by numpydoc !! .. py:property:: ProximitySizeSources :type: Optional[Ansys.Mechanical.DataModel.Enums.ProximitySFSourcesType] Gets or sets the ProximitySizeSources. .. !! processed by numpydoc !! .. py:property:: ReverseBias :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the ReverseBias. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: SphereCenter :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the SphereCenter. .. !! processed by numpydoc !! .. py:property:: SphereRadius :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the SphereRadius. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: Type :type: Optional[Ansys.Mechanical.DataModel.Enums.SizingType] Gets or sets the Type. .. !! 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:: 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:: GenerateMesh() -> None Generate the Mesh. .. !! 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