`AMBuildSettings`

class Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.AMBuildSettings

Bases: object

Defines a AMBuildSettings.

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.
CreateStrainScalingFactorTable	Creates a new AM strain scaling factor table.
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.
LoadBuildSettings	Run the LoadBuildSettings 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.
ResetToDefault	ResetToDefault - Restores default values of all properties.
SaveBuildSettings	Run the SaveBuildSettings action.

Properties

Name	Description
ASCParallel	Gets or sets the ASCParallel.
ASCPerpendicular	Gets or sets the ASCPerpendicular.
ASCVertical	Gets or sets the ASCVertical.
Absorptivity	Gets or sets the Absorptivity.
AdditiveProcess	Gets or sets the AdditiveProcess.
BeamDiameter	Gets or sets the beam diameter.
BeamPower	Gets or sets the beam power.
BuildGasConvectionCoefficient	Gets or sets the BuildGasConvectionCoefficient.
BuildGasOrPowderTemperatureType	Gets or sets the BuildGasOrPowderTemperatureType.
BuildGasTemperature	Gets or sets the BuildGasTemperature.
BuildMachineType	Gets or sets the BuildMachineType.
BuildPowderConvectionCoefficient	Gets or sets the BuildPowderConvectionCoefficient.
BuildPowderTemperature	Gets or sets the BuildPowderTemperature.
BuildRadiationEmissivity	Gets or sets the radiation emissivity for the build phase. If the input value is outside the accepted range of 0–1,
BuildSequence	Gets the build sequence. An exception is thrown if the EnableBuildSequence property is False.
BuildUseRadiationBC	Gets or sets whether to use the radiation boundary condition during the build phase.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
CooldownGasConvectionCoefficient	Gets or sets the CooldownGasConvectionCoefficient.
CooldownGasOrPowderTemperatureType	Gets or sets the CooldownGasOrPowderTemperatureType.
CooldownGasTemperature	Gets or sets the CooldownGasTemperature.
CooldownPowderConvectionCoefficient	Gets or sets the CooldownPowderConvectionCoefficient.
CooldownPowderTemperature	Gets or sets the CooldownPowderTemperature.
CooldownRadiationEmissivity	Gets or sets the radiation emissivity for the cool down phase. If the input value is outside the accepted range of 0–1,
CooldownUseRadiationBC	Gets or sets whether to use the radiation boundary condition during the cool down phase.
DataModelObjectCategory	Gets the current DataModelObject's category.
DepositionThickness	Gets or sets the DepositionThickness.
DwellTime	Gets or sets the DwellTime.
DwellTimeMultiple	Gets or sets the DwellTimeMultiple.
EnableBuildSequence	Gets or sets the EnableBuildSequence flag. This flag must be set to enable the Build Sequence Definition properties. [Default = False]
Figures	Gets the list of associated figures.
GeneratedLayerRotationAngle	Gets or sets the generated layer rotation angle.
GeneratedStartLayerAngle	Gets or sets the generated start layer angle.
HatchSpacing	Gets or sets the HatchSpacing.
HeatingDuration	Gets or sets the HeatingDuration.
HeatingMethod	Gets or sets the HeatingMethod.
Images	Gets the list of associated images.
InherentStrain	Gets or sets the InherentStrain.
InherentStrainDefinition	Gets or sets the InherentStrainDefinition.
InternalObject	Gets the internal object. For advanced usage only.
LayerHeightType	LayerHeightType - Get/Sets the layer height type.
LayerHeightValue	Gets or sets the LayerHeightValue.
MachineLearningModel	Gets or sets the MachineLearningModel.
NumberOfHeatSources	Gets or sets the NumberOfHeatSources.
PowderPropertyFactor	Gets or sets the PowderPropertyFactor.
PreheatTemperature	Gets or sets the PreheatTemperature.
Properties	Gets the list of properties for this object.
RoomTemperature	Gets or sets the RoomTemperature.
ScanPatternBuildFilePath	Gets or sets the ScanPatternBuildFilePath.
ScanPatternDefinition	Gets or sets the ScanPatternDefinition.
ScanSpeed	Gets or sets the ScanSpeed.
ScanStripeWidth	Gets or sets the scan stripe width.
StrainScalingFactor	Gets or sets the StrainScalingFactor.
StrainScalingFactorInterpolationMethod	StrainScalingFactorInterpolationMethod property.
StrainScalingFactorX	Gets or sets the StrainScalingFactorX.
StrainScalingFactorXInterpolationMethod	StrainScalingFactorXInterpolationMethod property.
StrainScalingFactorY	Gets or sets the StrainScalingFactorY.
StrainScalingFactorYInterpolationMethod	StrainScalingFactorYInterpolationMethod property.
StrainScalingFactorZ	Gets or sets the StrainScalingFactorZ.
StrainScalingFactorZInterpolationMethod	StrainScalingFactorZInterpolationMethod property.
ThermalStrainMaterialModel	Gets or sets the MachineLearningModel using the deprecated ThermalStrainMaterialModel methods.
ThermalStrainMethod	Gets or sets the ThermalStrainMethod.
ThermalStrainScalingFactor	Gets or sets the ThermalStrainScalingFactor.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property AMBuildSettings.ASCParallel : float | None

Gets or sets the ASCParallel.

property AMBuildSettings.ASCPerpendicular : float | None

Gets or sets the ASCPerpendicular.

property AMBuildSettings.ASCVertical : float | None

Gets or sets the ASCVertical.

property AMBuildSettings.Absorptivity : float | None

Gets or sets the Absorptivity.

property AMBuildSettings.AdditiveProcess : Ansys.Mechanical.DataModel.Enums.AMProcessType | None

Gets or sets the AdditiveProcess.

property AMBuildSettings.BeamDiameter : Any | None

Gets or sets the beam diameter.

The type for the setter can be either double or Quantity. Support for double is deprecated and will be removed in a future release. The type returned by the getter is a Quantity.

An exception will be thrown for unsupported types.

An exception will be thrown if the value is less than or equal to 0 with inherent strain disabled.

An exception will be thrown if the value is less than 0.00002 or greater than 0.00014 meters when inherent strain is enabled and the inherent strain definition is Thermal Strain.

property AMBuildSettings.BeamPower : Any | None

Gets or sets the beam power.

The type for the setter can be either double or Quantity. Support for double is deprecated and will be removed in a future release. The type returned by the getter is a Quantity.

An exception will be thrown for unsupported types.

An exception will be thrown if the value is less than or equal to 0 with inherent strain disabled.

An exception will be thrown if the value is less than 50 or greater than 700 watts when inherent strain is enabled and the inherent strain definition is Thermal Strain.

property AMBuildSettings.BuildGasConvectionCoefficient : Ansys.Core.Units.Quantity | None

Gets or sets the BuildGasConvectionCoefficient.

property AMBuildSettings.BuildGasOrPowderTemperatureType : Ansys.Mechanical.DataModel.Enums.AMProcessSettingsType | None

Gets or sets the BuildGasOrPowderTemperatureType.

property AMBuildSettings.BuildGasTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the BuildGasTemperature.

property AMBuildSettings.BuildMachineType : Ansys.Mechanical.DataModel.Enums.AMBuildMachineType | None

Gets or sets the BuildMachineType.

property AMBuildSettings.BuildPowderConvectionCoefficient : Ansys.Core.Units.Quantity | None

Gets or sets the BuildPowderConvectionCoefficient.

property AMBuildSettings.BuildPowderTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the BuildPowderTemperature.

property AMBuildSettings.BuildRadiationEmissivity : float | None

Gets or sets the radiation emissivity for the build phase. If the input value is outside the accepted range of 0–1, : an ArgumentOutOfRangeException is thrown. An InvalidOperationException is also thrown if BuildUseRadiationBC is set to false.

property AMBuildSettings.BuildSequence : Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.AMBuildSequence | None

Gets the build sequence. An exception is thrown if the EnableBuildSequence property is False.

property AMBuildSettings.BuildUseRadiationBC : bool | None

Gets or sets whether to use the radiation boundary condition during the build phase.

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

Gets the list of children.

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

Gets the list of associated comments.

property AMBuildSettings.CooldownGasConvectionCoefficient : Ansys.Core.Units.Quantity | None

Gets or sets the CooldownGasConvectionCoefficient.

property AMBuildSettings.CooldownGasOrPowderTemperatureType : Ansys.Mechanical.DataModel.Enums.AMProcessSettingsType | None

Gets or sets the CooldownGasOrPowderTemperatureType.

property AMBuildSettings.CooldownGasTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the CooldownGasTemperature.

property AMBuildSettings.CooldownPowderConvectionCoefficient : Ansys.Core.Units.Quantity | None

Gets or sets the CooldownPowderConvectionCoefficient.

property AMBuildSettings.CooldownPowderTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the CooldownPowderTemperature.

property AMBuildSettings.CooldownRadiationEmissivity : float | None

Gets or sets the radiation emissivity for the cool down phase. If the input value is outside the accepted range of 0–1, : an ArgumentOutOfRangeException is thrown. An InvalidOperationException is also thrown if CooldownUseRadiationBC is set to false.

property AMBuildSettings.CooldownUseRadiationBC : bool | None

Gets or sets whether to use the radiation boundary condition during the cool down phase.

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

Gets the current DataModelObject's category.

property AMBuildSettings.DepositionThickness : Ansys.Core.Units.Quantity | None

Gets or sets the DepositionThickness.

property AMBuildSettings.DwellTime : Ansys.Core.Units.Quantity | None

Gets or sets the DwellTime.

property AMBuildSettings.DwellTimeMultiple : float | None

Gets or sets the DwellTimeMultiple.

property AMBuildSettings.EnableBuildSequence : bool | None

Gets or sets the EnableBuildSequence flag. This flag must be set to enable the Build Sequence Definition properties. [Default = False]

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

Gets the list of associated figures.

property AMBuildSettings.GeneratedLayerRotationAngle : Any | None

Gets or sets the generated layer rotation angle.

The type for the setter can be either double or Quantity. Support for double is deprecated and will be removed in a future release. The type returned by the getter is a Quantity.

An exception will be thrown for unsupported types.

An exception will be thrown if the value is less than 0 or greater than 180 degrees.

property AMBuildSettings.GeneratedStartLayerAngle : Any | None

Gets or sets the generated start layer angle.

The type for the setter can be either double or Quantity. Support for double is deprecated and will be removed in a future release. The type returned by the getter is a Quantity.

An exception will be thrown for unsupported types.

An exception will be thrown if the value is less than 0 or greater than 180 degrees.

property AMBuildSettings.HatchSpacing : Ansys.Core.Units.Quantity | None

Gets or sets the HatchSpacing.

property AMBuildSettings.HeatingDuration : Ansys.Mechanical.DataModel.Enums.AMHeatingDurationType | None

Gets or sets the HeatingDuration.

property AMBuildSettings.HeatingMethod : Ansys.Mechanical.DataModel.Enums.AMHeatingMethod | None

Gets or sets the HeatingMethod.

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

Gets the list of associated images.

property AMBuildSettings.InherentStrain : bool | None

Gets or sets the InherentStrain.

property AMBuildSettings.InherentStrainDefinition : Ansys.Mechanical.DataModel.Enums.AMInherentStrainDefinition | None

Gets or sets the InherentStrainDefinition.

property AMBuildSettings.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAMProcessSettingsAuto | None

Gets the internal object. For advanced usage only.

property AMBuildSettings.LayerHeightType : Ansys.Mechanical.DataModel.Enums.AMLayerHeightType | None

LayerHeightType - Get/Sets the layer height type.

property AMBuildSettings.LayerHeightValue : Ansys.Core.Units.Quantity | None

Gets or sets the LayerHeightValue.

property AMBuildSettings.MachineLearningModel : Ansys.Mechanical.DataModel.Enums.AMMachineLearningModel | None

Gets or sets the MachineLearningModel.

property AMBuildSettings.NumberOfHeatSources : int | None

Gets or sets the NumberOfHeatSources.

property AMBuildSettings.PowderPropertyFactor : float | None

Gets or sets the PowderPropertyFactor.

property AMBuildSettings.PreheatTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the PreheatTemperature.

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

Gets the list of properties for this object.

property AMBuildSettings.RoomTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the RoomTemperature.

property AMBuildSettings.ScanPatternBuildFilePath : str | None

Gets or sets the ScanPatternBuildFilePath.

property AMBuildSettings.ScanPatternDefinition : Ansys.Mechanical.DataModel.Enums.AMScanPatternDefinition | None

Gets or sets the ScanPatternDefinition.

property AMBuildSettings.ScanSpeed : Ansys.Core.Units.Quantity | None

Gets or sets the ScanSpeed.

property AMBuildSettings.ScanStripeWidth : Any | None

Gets or sets the scan stripe width.

The type for the setter can be either double or Quantity. Support for double is deprecated and will be removed in a future release. The type returned by the getter is a Quantity.

An exception will be thrown for unsupported types.

An exception will be thrown if the value is less than 0 with inherent strain disabled.

An exception will be thrown if the value is less than 0.001 or greater than 0.1 meters when inherent strain is enabled and the inherent strain definition is Thermal Strain.

property AMBuildSettings.StrainScalingFactor : Any | None

Gets or sets the StrainScalingFactor.

property AMBuildSettings.StrainScalingFactorInterpolationMethod : Any | None

StrainScalingFactorInterpolationMethod property.

property AMBuildSettings.StrainScalingFactorX : Any | None

Gets or sets the StrainScalingFactorX.

property AMBuildSettings.StrainScalingFactorXInterpolationMethod : Any | None

StrainScalingFactorXInterpolationMethod property.

property AMBuildSettings.StrainScalingFactorY : Any | None

Gets or sets the StrainScalingFactorY.

property AMBuildSettings.StrainScalingFactorYInterpolationMethod : Any | None

StrainScalingFactorYInterpolationMethod property.

property AMBuildSettings.StrainScalingFactorZ : Any | None

Gets or sets the StrainScalingFactorZ.

property AMBuildSettings.StrainScalingFactorZInterpolationMethod : Any | None

StrainScalingFactorZInterpolationMethod property.

property AMBuildSettings.ThermalStrainMaterialModel : Ansys.Mechanical.DataModel.Enums.AMThermalStrainMaterialModel | None

Gets or sets the MachineLearningModel using the deprecated ThermalStrainMaterialModel methods.

property AMBuildSettings.ThermalStrainMethod : Ansys.Mechanical.DataModel.Enums.AMThermalStrainMethod | None

Gets or sets the ThermalStrainMethod.

property AMBuildSettings.ThermalStrainScalingFactor : float | None

Gets or sets the ThermalStrainScalingFactor.

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

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

Method detail

AMBuildSettings.Activate() → None

Activate the current object.

AMBuildSettings.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

AMBuildSettings.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

AMBuildSettings.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

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.

AMBuildSettings.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

AMBuildSettings.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

AMBuildSettings.CreateStrainScalingFactorTable() → Ansys.ACT.Automation.Mechanical.Table

Creates a new AM strain scaling factor table.

AMBuildSettings.Delete() → None

Run the Delete action.

AMBuildSettings.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

AMBuildSettings.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

AMBuildSettings.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

AMBuildSettings.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

AMBuildSettings.LoadBuildSettings(fName: str) → None

Run the LoadBuildSettings action.

AMBuildSettings.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

AMBuildSettings.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

AMBuildSettings.RemoveParameter(propName: str) → None

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

AMBuildSettings.ResetToDefault() → None

ResetToDefault - Restores default values of all properties.

AMBuildSettings.SaveBuildSettings(fName: str) → None

Run the SaveBuildSettings action.