The porosity.py module#

Summary#

PorosityInput

Provides input parameters for porosity simulation.

PorositySummary

Provides a summary of a porosity simulation.

Description#

Provides input and result summary containers for porosity simulations.

Module detail#

class porosity.PorosityInput(id: str = '', *, size_x: float = DEFAULT_SAMPLE_SIZE, size_y: float = DEFAULT_SAMPLE_SIZE, size_z: float = DEFAULT_SAMPLE_SIZE, machine: ansys.additive.core.machine.AdditiveMachine = AdditiveMachine(), material: ansys.additive.core.material.AdditiveMaterial = AdditiveMaterial())#

Provides input parameters for porosity simulation.

Overview#

id

User-provided ID for the simulation.

machine

Machine-related parameters.

material

Material used during the simulation.

size_x

Size (m) of the simulated sample in the x dimension.

size_y

Size (m) of the simulated sample in the y dimension.

size_z

Size (m) of the simulated sample in the z dimension.

DEFAULT_SAMPLE_SIZE

Default sample size in each dimension (m).

MIN_SAMPLE_SIZE

Minimum sample size in each dimension (m).

MAX_SAMPLE_SIZE

Maximum sample size in each dimension (m).

Import detail#

from ansys.additive.core.porosity import PorosityInput

Property detail#

property PorosityInput.id: str#

User-provided ID for the simulation.

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

Machine-related parameters.

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

Material used during the simulation.

property PorosityInput.size_x: float#

Size (m) of the simulated sample in the x dimension.

Valid values are from the MIN_SAMPLE_SIZE value to the MAX_SAMPLE_SIZE value.

property PorosityInput.size_y: float#

Size (m) of the simulated sample in the y dimension.

Valid values are from the MIN_SAMPLE_SIZE value to the MAX_SAMPLE_SIZE value.

property PorosityInput.size_z: float#

Size (m) of the simulated sample in the z dimension.

Valid values are from the MIN_SAMPLE_SIZE value to the MAX_SAMPLE_SIZE value.

Attribute detail#

PorosityInput.DEFAULT_SAMPLE_SIZE = 0.003#

Default sample size in each dimension (m).

PorosityInput.MIN_SAMPLE_SIZE = 0.001#

Minimum sample size in each dimension (m).

PorosityInput.MAX_SAMPLE_SIZE = 0.01#

Maximum sample size in each dimension (m).

class PorosityInput.PorositySummary(input: PorosityInput, result: ansys.api.additive.v0.additive_domain_pb2.PorosityResult)#

Provides a summary of a porosity simulation.

Overview#

input

Simulation input.

relative_density

Ratio of the density of the simulated sample to a completely solid sample.

Import detail#

from ansys.additive.core.porosity import PorositySummary

Property detail#

property PorositySummary.input: PorosityInput#

Simulation input.

property PorositySummary.relative_density: float#

Ratio of the density of the simulated sample to a completely solid sample.