Skip to main content

Mechanical scripting interface

Sizing

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.MeshControls.Sizing

Bases: object

Defines a Sizing.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
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.
GenerateMesh Generate the Mesh.
GetChildren Gets the list of children, filtered by type.
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
Active Gets the Active.
Behavior Gets or sets the Behavior.
BiasFactor Gets or sets the BiasFactor.
BiasGrowthRate Gets or sets the BiasGrowthRate.
BiasOption Gets or sets the BiasOption.
BiasType Gets or sets the BiasType.
BodyOfInfluence Gets the BodyOfInfluence.
CaptureCurvature Gets or sets the CaptureCurvature.
CaptureProximity Gets or sets the CaptureProximity.
Children Gets the list of children.
Comments Gets the list of associated comments.
CurvatureNormalAngle Gets or sets the CurvatureNormalAngle.
DataModelObjectCategory Gets the current DataModelObject’s category.
DefeatureSize Gets or sets the DefeatureSize.
ElementSize Gets or sets the ElementSize.
Figures Gets the list of associated figures.
GrowthRate Gets or sets the GrowthRate.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LocalMinimumSize Gets or sets the LocalMinimumSize.
Location Gets or sets the Location.
NamedSelection Gets or sets the NamedSelection.
NumberOfDivisions Gets or sets the NumberOfDivisions.
OriginX Gets the OriginX.
OriginY Gets the OriginY.
OriginZ Gets the OriginZ.
Properties Gets the list of properties for this object.
ProximityGapFactor Gets or sets the ProximityGapFactor.
ProximityMinimumSize Gets or sets the ProximityMinimumSize.
ProximitySizeSources Gets or sets the ProximitySizeSources.
ReverseBias Gets or sets the ReverseBias.
ScopingMethod Gets or sets the ScopingMethod.
SphereCenter Gets or sets the SphereCenter.
SphereRadius Gets or sets the SphereRadius.
Suppressed Gets or sets the Suppressed.
Type Gets or sets the Type.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property Sizing.Active : bool | None

Gets the Active.

property Sizing.Behavior : Ansys.Mechanical.DataModel.Enums.SizingBehavior | None

Gets or sets the Behavior.

property Sizing.BiasFactor : float | None

Gets or sets the BiasFactor.

property Sizing.BiasGrowthRate : float | None

Gets or sets the BiasGrowthRate.

property Sizing.BiasOption : Ansys.Mechanical.DataModel.Enums.BiasOptionType | None

Gets or sets the BiasOption.

property Sizing.BiasType : Ansys.Mechanical.DataModel.Enums.BiasType | None

Gets or sets the BiasType.

property Sizing.BodyOfInfluence : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets the BodyOfInfluence.

property Sizing.CaptureCurvature : bool | None

Gets or sets the CaptureCurvature.

property Sizing.CaptureProximity : bool | None

Gets or sets the CaptureProximity.

property Sizing.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Sizing.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Sizing.CurvatureNormalAngle : Ansys.Core.Units.Quantity | None

Gets or sets the CurvatureNormalAngle.

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

Gets the current DataModelObject’s category.

property Sizing.DefeatureSize : Ansys.Core.Units.Quantity | None

Gets or sets the DefeatureSize.

property Sizing.ElementSize : Ansys.Core.Units.Quantity | None

Gets or sets the ElementSize.

property Sizing.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Sizing.GrowthRate : float | None

Gets or sets the GrowthRate.

property Sizing.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Sizing.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSMeshControlAuto | None

Gets the internal object. For advanced usage only.

property Sizing.LocalMinimumSize : Ansys.Core.Units.Quantity | None

Gets or sets the LocalMinimumSize.

property Sizing.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property Sizing.NamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the NamedSelection.

property Sizing.NumberOfDivisions : int | None

Gets or sets the NumberOfDivisions.

property Sizing.OriginX : Ansys.Core.Units.Quantity | None

Gets the OriginX.

property Sizing.OriginY : Ansys.Core.Units.Quantity | None

Gets the OriginY.

property Sizing.OriginZ : Ansys.Core.Units.Quantity | None

Gets the OriginZ.

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

Gets the list of properties for this object.

property Sizing.ProximityGapFactor : Ansys.Core.Units.Quantity | None

Gets or sets the ProximityGapFactor.

property Sizing.ProximityMinimumSize : Ansys.Core.Units.Quantity | None

Gets or sets the ProximityMinimumSize.

property Sizing.ProximitySizeSources : Ansys.Mechanical.DataModel.Enums.ProximitySFSourcesType | None

Gets or sets the ProximitySizeSources.

property Sizing.ReverseBias : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReverseBias.

property Sizing.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property Sizing.SphereCenter : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the SphereCenter.

property Sizing.SphereRadius : Ansys.Core.Units.Quantity | None

Gets or sets the SphereRadius.

property Sizing.Suppressed : bool | None

Gets or sets the Suppressed.

property Sizing.Type : Ansys.Mechanical.DataModel.Enums.SizingType | None

Gets or sets the Type.

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

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

Method detail

Sizing.Activate()

Activate the current object.

Sizing.AddComment()

Creates a new child Comment.

Sizing.AddFigure()

Creates a new child Figure.

Sizing.AddImage(filePath: str)

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.

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

Copies all visible properties from this object to another.

Sizing.CreateParameter(propName: str)

Creates a new parameter for a Property.

Sizing.Delete()

Run the Delete action.

Sizing.Duplicate()

Creates a copy of the current DataModelObject.

Sizing.GenerateMesh()

Generate the Mesh.

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

Gets the list of children, filtered by type.

Sizing.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Sizing.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Sizing.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

Sizing.PropertyByName(name: str)

Get a property by its unique name.

Sizing.RemoveParameter(propName: str)

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

Sizing.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.