The thermal_history.py module#

Summary#

Range

Defines a range of values.

CoaxialAverageSensorInputs

Provides descriptions for coaxial average sensors.

ThermalHistoryInput

Provides input parameters for microstructure simulation.

ThermalHistorySummary

Summary of a thermal history simulation.

Description#

Provides input and result summary containers for thermal history simulations.

Module detail#

class thermal_history.Range(min: float, max: float)#

Defines a range of values.

Overview#

min

Minimum value of range.

max

Maximum value of range.

Import detail#

from ansys.additive.core.thermal_history import Range

Property detail#

property Range.min: float#

Minimum value of range.

property Range.max: float#

Maximum value of range.

class Range.CoaxialAverageSensorInputs(radius: float = MIN_SENSOR_RADIUS, z_heights: list[Range] = None)#

Provides descriptions for coaxial average sensors.

Overview#

radius

Radius of the circular field of the view of the sensor (m).

z_heights

Array of ranges along the z axis of the geometry (m).

MIN_SENSOR_RADIUS

Minimum radius for the circular field of view of the sensor (m).

MAX_SENSOR_RADIUS

Maximum radius for the circular field of view of the sensor (m).

Import detail#

from ansys.additive.core.thermal_history import CoaxialAverageSensorInputs

Property detail#

property CoaxialAverageSensorInputs.radius: float#

Radius of the circular field of the view of the sensor (m).

Valid values are from the MIN_SENSOR_RADIUS value to the MAX_SENSOR_RADIUS value.

property CoaxialAverageSensorInputs.z_heights: list[Range]#

Array of ranges along the z axis of the geometry (m).

The simulated sensor follows the scan path for each deposit layer within each range.

Attribute detail#

CoaxialAverageSensorInputs.MIN_SENSOR_RADIUS = 5e-05#

Minimum radius for the circular field of view of the sensor (m).

CoaxialAverageSensorInputs.MAX_SENSOR_RADIUS = 0.015#

Maximum radius for the circular field of view of the sensor (m).

class CoaxialAverageSensorInputs.ThermalHistoryInput(id: str = '', machine: ansys.additive.core.machine.AdditiveMachine = AdditiveMachine(), material: ansys.additive.core.material.AdditiveMaterial = AdditiveMaterial(), geometry: ansys.additive.core.geometry_file.StlFile | ansys.additive.core.geometry_file.BuildFile = None, coax_ave_sensor_inputs: CoaxialAverageSensorInputs = CoaxialAverageSensorInputs())#

Provides input parameters for microstructure simulation.

Overview#

id

User-provided ID for the simulation.

machine

Machine parameters.

material

Material parameters.

geometry

Part geometry.

coax_ave_sensor_inputs

Coaxial average sensor inputs.

Import detail#

from ansys.additive.core.thermal_history import ThermalHistoryInput

Property detail#

property ThermalHistoryInput.id: str#

User-provided ID for the simulation.

property ThermalHistoryInput.machine: ansys.additive.core.machine.AdditiveMachine#

Machine parameters.

property ThermalHistoryInput.material: ansys.additive.core.material.AdditiveMaterial#

Material parameters.

property ThermalHistoryInput.geometry: ansys.additive.core.geometry_file.StlFile | ansys.additive.core.geometry_file.BuildFile#

Part geometry.

property ThermalHistoryInput.coax_ave_sensor_inputs: CoaxialAverageSensorInputs#

Coaxial average sensor inputs.

class ThermalHistoryInput.ThermalHistorySummary(input: ThermalHistoryInput, coax_ave_output_folder: str)#

Summary of a thermal history simulation.

Overview#

input

Simulation input.

coax_ave_output_folder

Path to the folder containing the coaxial average sensor results.

Import detail#

from ansys.additive.core.thermal_history import ThermalHistorySummary

Property detail#

property ThermalHistorySummary.input: ThermalHistoryInput#

Simulation input.

For more information, see the ThermalHistoryInput class.

property ThermalHistorySummary.coax_ave_output_folder: str#

Path to the folder containing the coaxial average sensor results.

Results consist of VTK files, one per deposit layer, containing the thermal history of the scan pattern.