The simulation.py module

Summary

Classes

SimulationType	Provides simulation types.
SimulationStatus	Provides simulation status values.
SimulationError	Provides simulation errors.

Description

Provides common definitions and classes for simulations.

Module detail

class simulation.SimulationType

Provides simulation types.

Overview

Attributes

SINGLE_BEAD	Single bead simulation.
POROSITY	Porosity simulation.
MICROSTRUCTURE	Microstructure simulation.

Import detail

from ansys.additive.core.simulation import SimulationType

Attribute detail

SimulationType.SINGLE_BEAD = 'SingleBead'

Single bead simulation.

SimulationType.POROSITY = 'Porosity'

Porosity simulation.

SimulationType.MICROSTRUCTURE = 'Microstructure'

Microstructure simulation.

class SimulationType.SimulationStatus

Provides simulation status values.

Overview

Attributes

PENDING	Simulation is waiting to run.
COMPLETED	Simulation was run.
ERROR	Simulation errored.
SKIP	Do not run this simulation, only applies to parametric studies.

Import detail

from ansys.additive.core.simulation import SimulationStatus

Attribute detail

SimulationStatus.PENDING = 'Pending'

Simulation is waiting to run.

SimulationStatus.COMPLETED = 'Completed'

Simulation was run.

SimulationStatus.ERROR = 'Error'

Simulation errored.

SimulationStatus.SKIP = 'Skip'

Do not run this simulation, only applies to parametric studies.

class SimulationStatus.SimulationError(input: ansys.additive.core.single_bead.SingleBeadInput | ansys.additive.core.porosity.PorosityInput | ansys.additive.core.microstructure.MicrostructureInput | ansys.additive.core.thermal_history.ThermalHistoryInput, message: str)

Provides simulation errors.

Overview

Properties

input	Simulation input.
message	Provides simulation error message.

Import detail

from ansys.additive.core.simulation import SimulationError

Property detail

property SimulationError.input: ansys.additive.core.single_bead.SingleBeadInput | ansys.additive.core.porosity.PorosityInput | ansys.additive.core.microstructure.MicrostructureInput | ansys.additive.core.thermal_history.ThermalHistoryInput

Simulation input.

property SimulationError.message: str

Provides simulation error message.