Class: AMBuildSettings

Defines a AMBuildSettings.

Methods

Name Description
Activate() Activate the current object.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) 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.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) 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(Boolean, IList<ChildrenType>)
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
LoadBuildSettings(String) Run the LoadBuildSettings action.
PropertyByAPIName(String) 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.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
ResetToDefault() ResetToDefault - Restores default values of all properties.
SaveBuildSettings(String) Run the SaveBuildSettings action.

Properties

Name Description
Absorptivity Gets or sets the Absorptivity.
AdditiveProcess Gets or sets the AdditiveProcess.
ASCParallel Gets or sets the ASCParallel.
ASCPerpendicular Gets or sets the ASCPerpendicular.
ASCVertical Gets or sets the ASCVertical.
BeamDiameter ***OBSOLETE*** Use of `double` for BeamDiameter is deprecated, use `Quantity` instead. 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.
BeamPower ***OBSOLETE*** Use of `double` for BeamPower is deprecated, use `Quantity` instead. 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.
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, an ArgumentOutOfRangeException is thrown. An InvalidOperationException is also thrown if BuildUseRadiationBC is set to false.
BuildRoomTemperature Gets or sets the ambient gas temperature in the chamber during printing. Used as the ambient reference for convection and radiation on all active clusters and base surfaces during the build. Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than or equal to 0 °C.
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.
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, an ArgumentOutOfRangeException is thrown. An InvalidOperationException is also thrown if CooldownUseRadiationBC is set to false.
CooldownRoomTemperature Gets or sets the ambient gas temperature in the chamber during cooldown. Used as the ambient reference for convection and radiation on all active clusters and base surfaces during the build. An exception is thrown if the supplied value is less than or equal to 0 °C.
CooldownTime Gets or sets the duration of the cooldown process. Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than 0.
CooldownUseRadiationBC Gets or sets whether to use the radiation boundary condition during the cool down phase.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DEDBuildGasConvectionCoefficientBase Gets or sets the convection coefficient from base plate outer surfaces to chamber gas during printing. Controls how strongly the base plate acts as a heat sink. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition or if the supplied value is less than 0.
DEDBuildGasConvectionCoefficientPart Gets or sets the convection coefficient from build surfaces to chamber gas during printing. Automatically applied to each activated cluster. Low values approximate adiabatic conditions; higher values increase cooling, especially important for bulky structures. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition or if the supplied value is less than 0.
DEDBuildRadiationEmissivityBase Gets or sets the emissivity of base plate surfaces during build. Changes how strongly the base plate exchanges heat radiatively with the environment. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition. An exception is also thrown if the supplied value is less than 0, or greater than 1.
DEDBuildRadiationEmissivityPart Gets or sets the emissivity of build surfaces during build. Higher values increase radiative heat loss from the printed part. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition. An exception is also thrown if the supplied value is less than 0, or greater than 1.
DEDClusterCoolingTimeRatio Gets or sets the ratio defining the cooling portion of total cluster time. Lower values shorten cooling and lengthen effective heating, increasing temperature spikes. A value of 0.8 means ~20 % of cluster time is heating and ~80 % is cooling. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition. An exception is also thrown if the supplied value is less than or equal to 0, or greater than 1.
DEDCooldownGasConvectionCoefficientBase Gets or sets the convection coefficient from base plate surfaces to chamber gas during cooldown. Governs how quickly the base plate returns to ambient conditions. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition or if the supplied value is less than 0.
DEDCooldownGasConvectionCoefficientPart Gets or sets the convection coefficient from build surfaces to chamber gas during cooldown. Higher values increase cooling after deposition stops; very low values can nearly disable convection for sensitivity studies. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition or if the supplied value is less than 0.
DEDCooldownRadiationEmissivityBase Gets or sets the emissivity of base plate surfaces during cooldown. Changes how strongly the base plate exchanges heat radiatively with the environment. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition. An exception is also thrown if the supplied value is less than 0, or greater than 1.
DEDCooldownRadiationEmissivityPart Gets or sets the emissivity of build surfaces during cooldown. Higher values increase radiative heat loss from the printed part. An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition. An exception is also thrown if the supplied value is less than 0, or greater than 1.
DEDMaterialDepositionRate Gets or sets the material feed rate in volume per time unit determined by layer thickness × weld width × deposition speed. Along with Cluster Volume, it defines cluster time (volume ÷ deposition rate). An exception is thrown if the AMProcessType property is not DirectedEnergyDeposition. An exception is also thrown if the supplied value is less than or equal to 0.
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 ***OBSOLETE*** Use of `double` for GeneratedLayerRotationAngle is deprecated, use `Quantity` instead. 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.
GeneratedStartLayerAngle ***OBSOLETE*** Use of `double` for GeneratedStartLayerAngle is deprecated, use `Quantity` instead. 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.
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.
InterpassCoolingConvergenceThreshold Gets or sets the maximum allowed percent change in the layer’s maximum temperature between iterations. Cooling is considered converged when the change is less than or equal to this value. Default is 0.1 (10%). Available when the interpass cooling method is set to TemperatureBased. Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than 0, or greater than 1.
InterpassCoolingMaxIterationNumLayer Gets or sets the upper limit on the number of cooling iterations per layer when using TemperatureBased interpass cooling method. Default is 5. Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than 1.
InterpassCoolingMethod Gets or sets the method used to control dwell time between layers. Applicable only when AMProcessType property is DirectedEnergyDeposition.
InterpassCoolingTargetTemperature Gets or sets the temperature that a layer must cool to before the next layer begins. Available when the interpass cooling method is set to TemperatureBased. Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than or equal to 0 °C.
InterpassCoolingTimeStepSize Gets or sets the time increment between repeated thermal solves while cooling a layer in TemperatureBased interpass cooling method. Smaller values give finer control but require more solves. Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than or equal to 0.
LayerHeightType LayerHeightType - Get/Sets the layer height type.
LayerHeightValue Gets or sets the LayerHeightValue.
MachineLearningModel Gets or sets the MachineLearningModel.
Name Gets the name of the object.
NumberOfHeatSources Gets or sets the NumberOfHeatSources.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
PowderPropertyFactor Gets or sets the PowderPropertyFactor.
PreheatDuringPrinting Gets or set whether to apply a temperature boundary condition throughout the entire build. When set to False, the boundary condition is applied only in the first load step; When set to True, the boundary condition is maintained during all cluster activations. Default: False. Applicable only when AMProcessType property is DirectedEnergyDeposition.
PreheatGeometry Gets or sets the preheat geometry scoping. Applicable only when AdditiveProcess is DirectedEnergyDeposition and PreheatDuringPrinting is On. Otherwise, an exception is thrown.
PreheatTemperature Gets or sets the preheat temperature on the build plate. An exception is thrown if the supplied value is less than or equal to 0 °C. When AdditiveProcess is PowderBedFusion, it sets the value of the starting temperature of the build plate. When AdditiveProcess is DirectedEnergyDeposition and PreheatDuringPrinting is On, this temperature is prescribed on the scoped geometry as a boundary condition.
ProcessTemperature Gets or sets the temperature of the feed material as it is exiting the nozzle—usually melting temperature or above. This value automatically defaults to the build material's melting temperature (or 1000 °C if the melting temperature is not defined). Applicable only when AMProcessType property is DirectedEnergyDeposition. An exception is thrown if the supplied value is less than or equal to 0 °C.
Properties Gets the list of properties for this object.
RemovalStep Gets or sets whether to perform base removal after cooldown. Default: False. Applicable only when the AMProcessType property is set to DirectedEnergyDeposition.
ScanPatternBuildFilePath Gets or sets the ScanPatternBuildFilePath.
ScanPatternDefinition Gets or sets the ScanPatternDefinition.
ScanSpeed Gets or sets the ScanSpeed.
ScanStripeWidth ***OBSOLETE*** Use of `double` for ScanStripeWidth is deprecated, use `Quantity` instead. 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.
StrainScalingFactor Gets or sets the StrainScalingFactor.
StrainScalingFactorInterpolationMethod
StrainScalingFactorX Gets or sets the StrainScalingFactorX.
StrainScalingFactorXInterpolationMethod
StrainScalingFactorY Gets or sets the StrainScalingFactorY.
StrainScalingFactorYInterpolationMethod
StrainScalingFactorZ Gets or sets the StrainScalingFactorZ.
StrainScalingFactorZInterpolationMethod
ThermalStrainMaterialModel ***OBSOLETE*** ThermalStrainMaterialModel is deprecated, please use MachineLearningModel instead. 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.