The constants.py module

Summary

Classes

ColumnNames

Provides column names for the parametric study data frame.

Constants

DEFAULT_ITERATION	Default iteration assigned to new simulations.
DEFAULT_PRIORITY	Default priority assigned to new simulations.
FORMAT_VERSION	Parametric study file format version.

Description

Provides constant values related to parametric studies.

Module detail

class constants.ColumnNames

Provides column names for the parametric study data frame.

Values are stored internally as a Pandas DataFrame. Column name definitions follow.

Overview

Attributes

ITERATION	Optional iteration number, useful for tracking the sequence of
PRIORITY	Priority value used to determine execution order.
TYPE	Type of simulation.
ID	Unique identifier for the simulation.
STATUS	Status of the simulation.
MATERIAL	Name of material used during simulation.
HEATER_TEMPERATURE	Heater temperature (C).
LAYER_THICKNESS	Powder deposition layer thickness (m).
BEAM_DIAMETER	Laser beam diameter (m).
LASER_POWER	Laser power (W).
SCAN_SPEED	Laser scan speed (m/s).
START_ANGLE	Hatch scan angle for first layer (degrees).
ROTATION_ANGLE	Hatch rotation angle for subsequent layers (degrees).
HATCH_SPACING	Hatch spacing (m).
STRIPE_WIDTH	Stripe width (m).
ENERGY_DENSITY	Laser power divided by build rate (J/m^3).
SINGLE_BEAD_LENGTH	Length of single bead to simulate (m).
BUILD_RATE	Layer thickness * scan speed * hatch spacing (m^3/s).
MELT_POOL_WIDTH	Median melt pool width measured at the top of the powder layer (m).
MELT_POOL_DEPTH	Median melt pool depth measured from the top of the powder layer (m).
MELT_POOL_LENGTH	Median melt pool length measured at the top of the powder layer (m).
MELT_POOL_LENGTH_OVER_WIDTH	Ratio of MELT_POOL_LENGTH to MELT_POOL_WIDTH.
MELT_POOL_REFERENCE_WIDTH	Median melt pool width measured at the top of the base plate (m).
MELT_POOL_REFERENCE_DEPTH	Median melt pool depth measured from the top of the base plate (m).
MELT_POOL_REFERENCE_DEPTH_OVER_WIDTH	Ratio of MELT_POOL_REFERENCE_DEPTH to MELT_POOL_REFERENCE_WIDTH.
POROSITY_SIZE_X	X dimension size of porosity sample to simulate (m).
POROSITY_SIZE_Y	Y dimension size of Porosity sample to simulate (m).
POROSITY_SIZE_Z	Z dimension size of Porosity sample to simulate (m).
RELATIVE_DENSITY	Relative density of simulated porosity sample.
MICRO_MIN_X	Minimum X dimension position of microstructure sample (m).
MICRO_MIN_Y	Minimum Y dimension position of microstructure sample (m).
MICRO_MIN_Z	Minimum Z dimension position of microstructure sample (m).
MICRO_SIZE_X	X dimension size of microstructure sample to simulate (m).
MICRO_SIZE_Y	Y dimension size of microstructure sample to simulate (m).
MICRO_SIZE_Z	Z dimension size of microstructure sample to simulate (m).
MICRO_SENSOR_DIM	Sensor dimension used in microstructure simulations (m).
COOLING_RATE	User-provided cooling rate used in microstructure simulations (K/s).
THERMAL_GRADIENT	User-provided thermal gradient used in microstructure simulations (K/m).
MICRO_MELT_POOL_WIDTH	User-provided melt pool width used in microstructure simulation (m).
MICRO_MELT_POOL_DEPTH	User-provided melt pool depth used in microstructure simulation (m).
RANDOM_SEED	User-provided random seed used in microstructure simulation.
XY_AVERAGE_GRAIN_SIZE	Average microstructure grain size in the XY plane (microns).
XZ_AVERAGE_GRAIN_SIZE	Average microstructure grain size in the XZ plane (microns).
YZ_AVERAGE_GRAIN_SIZE	Average microstructure grain size in the YZ plane (microns).
ERROR_MESSAGE	Error message if simulation failed.

Import detail

from ansys.additive.core.parametric_study.constants import ColumnNames

Attribute detail

ColumnNames.ITERATION = 'Iteration'

Optional iteration number, useful for tracking the sequence of simulation groups.

ColumnNames.PRIORITY = 'Priority'

Priority value used to determine execution order.

ColumnNames.TYPE = 'Type'

Type of simulation.

ColumnNames.ID = 'ID'

Unique identifier for the simulation.

ColumnNames.STATUS = 'Status'

Status of the simulation.

ColumnNames.MATERIAL = 'Material'

Name of material used during simulation.

ColumnNames.HEATER_TEMPERATURE = 'Heater Temp (C)'

Heater temperature (C).

ColumnNames.LAYER_THICKNESS = 'Layer Thickness (m)'

Powder deposition layer thickness (m).

ColumnNames.BEAM_DIAMETER = 'Beam Diameter (m)'

Laser beam diameter (m).

ColumnNames.LASER_POWER = 'Laser Power (W)'

Laser power (W).

ColumnNames.SCAN_SPEED = 'Scan Speed (m/s)'

Laser scan speed (m/s).

ColumnNames.START_ANGLE = 'Start Angle (degrees)'

Hatch scan angle for first layer (degrees).

ColumnNames.ROTATION_ANGLE = 'Rotation Angle (degrees)'

Hatch rotation angle for subsequent layers (degrees).

ColumnNames.HATCH_SPACING = 'Hatch Spacing (m)'

Hatch spacing (m).

ColumnNames.STRIPE_WIDTH = 'Stripe Width (m)'

Stripe width (m).

ColumnNames.ENERGY_DENSITY = 'Energy Density (J/m^3)'

Laser power divided by build rate (J/m^3).

ColumnNames.SINGLE_BEAD_LENGTH = 'Single Bead Length (m)'

Length of single bead to simulate (m).

ColumnNames.BUILD_RATE = 'Build Rate (m^3/s)'

Layer thickness * scan speed * hatch spacing (m^3/s).

ColumnNames.MELT_POOL_WIDTH = 'Melt Pool Width (m)'

Median melt pool width measured at the top of the powder layer (m).

ColumnNames.MELT_POOL_DEPTH = 'Melt Pool Depth (m)'

Median melt pool depth measured from the top of the powder layer (m).

ColumnNames.MELT_POOL_LENGTH = 'Melt Pool Length (m)'

Median melt pool length measured at the top of the powder layer (m).

ColumnNames.MELT_POOL_LENGTH_OVER_WIDTH = 'Melt Pool Length/Width'

Ratio of MELT_POOL_LENGTH to MELT_POOL_WIDTH.

ColumnNames.MELT_POOL_REFERENCE_WIDTH = 'Melt Pool Ref Width (m)'

Median melt pool width measured at the top of the base plate (m).

ColumnNames.MELT_POOL_REFERENCE_DEPTH = 'Melt Pool Ref Depth (m)'

Median melt pool depth measured from the top of the base plate (m).

ColumnNames.MELT_POOL_REFERENCE_DEPTH_OVER_WIDTH = 'Melt Pool Ref Depth/Width'

Ratio of MELT_POOL_REFERENCE_DEPTH to MELT_POOL_REFERENCE_WIDTH.

ColumnNames.POROSITY_SIZE_X = 'Porosity Size X (m)'

X dimension size of porosity sample to simulate (m).

ColumnNames.POROSITY_SIZE_Y = 'Porosity Size Y (m)'

Y dimension size of Porosity sample to simulate (m).

ColumnNames.POROSITY_SIZE_Z = 'Porosity Size Z (m)'

Z dimension size of Porosity sample to simulate (m).

ColumnNames.RELATIVE_DENSITY = 'Relative Density'

Relative density of simulated porosity sample.

ColumnNames.MICRO_MIN_X = 'Micro Min X (m)'

Minimum X dimension position of microstructure sample (m).

ColumnNames.MICRO_MIN_Y = 'Micro Min Y (m)'

Minimum Y dimension position of microstructure sample (m).

ColumnNames.MICRO_MIN_Z = 'Micro Min Z (m)'

Minimum Z dimension position of microstructure sample (m).

ColumnNames.MICRO_SIZE_X = 'Micro Size X (m)'

X dimension size of microstructure sample to simulate (m).

ColumnNames.MICRO_SIZE_Y = 'Micro Size Y (m)'

Y dimension size of microstructure sample to simulate (m).

ColumnNames.MICRO_SIZE_Z = 'Micro Size Z (m)'

Z dimension size of microstructure sample to simulate (m).

ColumnNames.MICRO_SENSOR_DIM = 'Micro Sensor Dim (m)'

Sensor dimension used in microstructure simulations (m).

ColumnNames.COOLING_RATE = 'Cooling Rate (K/s)'

User-provided cooling rate used in microstructure simulations (K/s).

ColumnNames.THERMAL_GRADIENT = 'Thermal Gradient (K/m)'

User-provided thermal gradient used in microstructure simulations (K/m).

ColumnNames.MICRO_MELT_POOL_WIDTH = 'Micro Melt Pool Width (m)'

User-provided melt pool width used in microstructure simulation (m).

ColumnNames.MICRO_MELT_POOL_DEPTH = 'Micro Melt Pool Depth (m)'

User-provided melt pool depth used in microstructure simulation (m).

ColumnNames.RANDOM_SEED = 'Random Seed'

User-provided random seed used in microstructure simulation.

ColumnNames.XY_AVERAGE_GRAIN_SIZE = 'XY Average Grain Size (microns)'

Average microstructure grain size in the XY plane (microns).

ColumnNames.XZ_AVERAGE_GRAIN_SIZE = 'XZ Average Grain Size (microns)'

Average microstructure grain size in the XZ plane (microns).

ColumnNames.YZ_AVERAGE_GRAIN_SIZE = 'YZ Average Grain Size (microns)'

Average microstructure grain size in the YZ plane (microns).

ColumnNames.ERROR_MESSAGE = 'Error Message'

Error message if simulation failed.

ColumnNames.DEFAULT_ITERATION = 0

Default iteration assigned to new simulations.

ColumnNames.DEFAULT_PRIORITY = 1

Default priority assigned to new simulations.

ColumnNames.FORMAT_VERSION = 2

Parametric study file format version.