Skip to main content

Mechanical scripting interface

AMSupport

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.AMSupport

Bases: object

Defines a AMSupport.

Overview

Methods

Name Description
Activate Activate the current object.
AddCommandSnippet Creates a new CommandSnippet
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.
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.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
DensityMultiple Gets or sets the DensityMultiple.
ElasticModulusMultipleInX Gets or sets the ElasticModulusMultipleInX.
ElasticModulusMultipleInY Gets or sets the ElasticModulusMultipleInY.
ElasticModulusMultipleInZ Gets or sets the ElasticModulusMultipleInZ.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
MaterialMultiplier Gets or sets the MaterialMultiplier.
MultiplierEntry Gets or sets the MultiplierEntry.
Properties Gets the list of properties for this object.
ShearModulusMultipleInXY Gets or sets the ShearModulusMultipleInXY.
ShearModulusMultipleInXZ Gets or sets the ShearModulusMultipleInXZ.
ShearModulusMultipleInYZ Gets or sets the ShearModulusMultipleInYZ.
SupportType Gets or sets the SupportType.
ThermalConductivityMultipleInX Gets or sets the ThermalConductivityMultipleInX.
ThermalConductivityMultipleInY Gets or sets the ThermalConductivityMultipleInY.
ThermalConductivityMultipleInZ Gets or sets the ThermalConductivityMultipleInZ.
VisibleProperties Gets the list of properties that are visible for this object.
Volume Gets or sets the Volume.
WallSpacing Gets or sets the WallSpacing.
WallThickness Gets or sets the WallThickness.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property AMSupport.DensityMultiple : float | None

Gets or sets the DensityMultiple.

property AMSupport.ElasticModulusMultipleInX : float | None

Gets or sets the ElasticModulusMultipleInX.

property AMSupport.ElasticModulusMultipleInY : float | None

Gets or sets the ElasticModulusMultipleInY.

property AMSupport.ElasticModulusMultipleInZ : float | None

Gets or sets the ElasticModulusMultipleInZ.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property AMSupport.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAMSupportAuto | None

Gets the internal object. For advanced usage only.

property AMSupport.MaterialMultiplier : float | None

Gets or sets the MaterialMultiplier.

property AMSupport.MultiplierEntry : Ansys.Mechanical.DataModel.Enums.AMMultiplierEntryType | None

Gets or sets the MultiplierEntry.

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

Gets the list of properties for this object.

property AMSupport.ShearModulusMultipleInXY : float | None

Gets or sets the ShearModulusMultipleInXY.

property AMSupport.ShearModulusMultipleInXZ : float | None

Gets or sets the ShearModulusMultipleInXZ.

property AMSupport.ShearModulusMultipleInYZ : float | None

Gets or sets the ShearModulusMultipleInYZ.

property AMSupport.SupportType : Ansys.Mechanical.DataModel.Enums.AMSupportType | None

Gets or sets the SupportType.

property AMSupport.ThermalConductivityMultipleInX : float | None

Gets or sets the ThermalConductivityMultipleInX.

property AMSupport.ThermalConductivityMultipleInY : float | None

Gets or sets the ThermalConductivityMultipleInY.

property AMSupport.ThermalConductivityMultipleInZ : float | None

Gets or sets the ThermalConductivityMultipleInZ.

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

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

property AMSupport.Volume : Ansys.Core.Units.Quantity | None

Gets or sets the Volume.

property AMSupport.WallSpacing : Ansys.Core.Units.Quantity | None

Gets or sets the WallSpacing.

property AMSupport.WallThickness : Ansys.Core.Units.Quantity | None

Gets or sets the WallThickness.

Method detail

AMSupport.Activate()

Activate the current object.

AMSupport.AddCommandSnippet()

Creates a new CommandSnippet

AMSupport.AddComment()

Creates a new child Comment.

AMSupport.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

AMSupport.CreateParameter(propName: str)

Creates a new parameter for a Property.

AMSupport.Delete()

Run the Delete action.

AMSupport.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

AMSupport.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

AMSupport.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

AMSupport.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

AMSupport.PropertyByName(name: str)

Get a property by its unique name.

AMSupport.RemoveParameter(propName: str)

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