The single_bead.py module

Summary

Classes

SingleBeadInput	Provides input parameters for a single bead simulation.
MeltPoolColumnNames	Provides column names for the melt pool data frame.
MeltPool	Contains the melt pool size dimensions for each time step during a single bead simulation.
SingleBeadSummary	Provides a summary of a single bead simulation.

Description

Provides input and result summary containers for single bead simulations.

Module detail

class single_bead.SingleBeadInput(id: str = '', bead_length: float = DEFAULT_BEAD_LENGTH, machine: ansys.additive.core.machine.AdditiveMachine = AdditiveMachine(), material: ansys.additive.core.material.AdditiveMaterial = AdditiveMaterial())

Provides input parameters for a single bead simulation.

Overview

Properties

id	User-provided ID for the simulation.
machine	Machine parameters.
material	Material parameters.
bead_length	Length (m) of bead to simulate.

Attributes

DEFAULT_BEAD_LENGTH	Default bead length (m).
MIN_BEAD_LENGTH	Minimum bead length (m).
MAX_BEAD_LENGTH	Maximum bead length (m).

Import detail

from ansys.additive.core.single_bead import SingleBeadInput

Property detail

property SingleBeadInput.id: str

User-provided ID for the simulation.

property SingleBeadInput.machine: ansys.additive.core.machine.AdditiveMachine

Machine parameters.

property SingleBeadInput.material: ansys.additive.core.material.AdditiveMaterial

Material parameters.

property SingleBeadInput.bead_length: float

Length (m) of bead to simulate.

Valid values are from the MIN_BEAD_LENGTH value to the MAX_BEAD_LENGTH value.

Attribute detail

SingleBeadInput.DEFAULT_BEAD_LENGTH = 0.003

Default bead length (m).

SingleBeadInput.MIN_BEAD_LENGTH = 0.001

Minimum bead length (m).

SingleBeadInput.MAX_BEAD_LENGTH = 0.01

Maximum bead length (m).

class SingleBeadInput.MeltPoolColumnNames

Provides column names for the melt pool data frame.

Overview

Attributes

WIDTH	Width of melt pool (m).
DEPTH	Depth of melt pool (m).
LENGTH	Length of melt pool (m).
REFERENCE_WIDTH	Width of melt pool at the surface of the base plate (m).
REFERENCE_DEPTH	Depth of melt pool measured from the surface of the base plate (m).

Import detail

from ansys.additive.core.single_bead import MeltPoolColumnNames

Attribute detail

MeltPoolColumnNames.WIDTH = 'width'

Width of melt pool (m).

MeltPoolColumnNames.DEPTH = 'depth'

Depth of melt pool (m).

MeltPoolColumnNames.LENGTH = 'length'

Length of melt pool (m).

MeltPoolColumnNames.REFERENCE_WIDTH = 'reference_width'

Width of melt pool at the surface of the base plate (m).

MeltPoolColumnNames.REFERENCE_DEPTH = 'reference_depth'

Depth of melt pool measured from the surface of the base plate (m).

class MeltPoolColumnNames.MeltPool(msg: ansys.api.additive.v0.additive_domain_pb2.MeltPool)

Contains the melt pool size dimensions for each time step during a single bead simulation.

Overview

Methods

data_frame

Get the data frame containing the melt pool data.

Import detail

from ansys.additive.core.single_bead import MeltPool

Method detail

MeltPool.data_frame() → pandas.DataFrame

Get the data frame containing the melt pool data.

Values are in meters.

Indices:

• bead_length: Length of the bead at each time step.

Columns:

• MeltPoolColumnNames.LENGTH.

• MeltPoolColumnNames.WIDTH.

• MeltPoolColumnNames.DEPTH.

• MeltPoolColumnNames.REFERENCE_WIDTH.

• MeltPoolColumnNames.REFERENCE_DEPTH.

class MeltPool.SingleBeadSummary(input: SingleBeadInput, msg: ansys.api.additive.v0.additive_domain_pb2.MeltPool)

Provides a summary of a single bead simulation.

Overview

Properties

input	Simulation input.
melt_pool	Resulting melt pool.

Import detail

from ansys.additive.core.single_bead import SingleBeadSummary

Property detail

property SingleBeadSummary.input: SingleBeadInput

Simulation input.

property SingleBeadSummary.melt_pool: MeltPool

Resulting melt pool.