MicrostructureSummary

class MicrostructureSummary(input: MicrostructureInput, result: ansys.api.additive.v0.additive_domain_pb2.MicrostructureResult, user_data_path: str)

Provides the summary of a microstructure simulation.

Overview

Properties

input	Simulation input.
xy_vtk	Path to the VTK file containing the 2-D grain structure data in the XY plane.
xz_vtk	Path to the VTK file containing the 2-D grain structure data in the XZ plane.
yz_vtk	Path to the VTK file containing the 2-D grain structure data in the YZ plane.
xy_circle_equivalence	Circle equivalence data for the XY plane.
xz_circle_equivalence	Circle equivalence data for the XZ plane.
yz_circle_equivalence	Circle equivalence data for the YZ plane.
xy_average_grain_size	Average grain size (µm) for the XY plane.
xz_average_grain_size	Average grain size (µm) for the XZ plane.
yz_average_grain_size	Average grain size (µm) for the YZ plane.

Import detail

from ansys.additive.core.microstructure import MicrostructureSummary

Property detail

property MicrostructureSummary.input: None

Simulation input.

For more information, see the MicrostructureInput class.

property MicrostructureSummary.xy_vtk: str

Path to the VTK file containing the 2-D grain structure data in the XY plane.

property MicrostructureSummary.xz_vtk: str

Path to the VTK file containing the 2-D grain structure data in the XZ plane.

property MicrostructureSummary.yz_vtk: str

Path to the VTK file containing the 2-D grain structure data in the YZ plane.

property MicrostructureSummary.xy_circle_equivalence: pandas.DataFrame

Circle equivalence data for the XY plane.

For data frame column names, see the CircleEquivalenceColumnNames class.

property MicrostructureSummary.xz_circle_equivalence: pandas.DataFrame

Circle equivalence data for the XZ plane.

For data frame column names, see the CircleEquivalenceColumnNames class.

property MicrostructureSummary.yz_circle_equivalence: pandas.DataFrame

Circle equivalence data for the YZ plane.

For data frame column names, see the CircleEquivalenceColumnNames class.

property MicrostructureSummary.xy_average_grain_size: float

Average grain size (µm) for the XY plane.

property MicrostructureSummary.xz_average_grain_size: float

Average grain size (µm) for the XZ plane.

property MicrostructureSummary.yz_average_grain_size: float

Average grain size (µm) for the YZ plane.