sgio.create_pyvista_local_axis_multiblock#

sgio.create_pyvista_local_axis_multiblock(mesh: SGMesh, *, max_local_axes: int | None = None, local_axis_scale: float | None = None) → pyvista.MultiBlock#

Create a VTM-ready mesh and local-axis glyph scene.

Parameters:

  • mesh (SGMesh) – Mesh providing geometry and element local-coordinate data.

  • max_local_axes (int, optional) – Maximum number of cells receiving local-axis glyphs. None writes glyphs for every cell, which is the default for VTM export.

  • local_axis_scale (float, optional) – Glyph length in mesh coordinate units. If omitted, the length is 2.5% of the mesh bounding-box diagonal.

Returns:

Blocks named mesh, local_y1, local_y2, and local_y3. The three local-axis blocks are omitted when no local coordinate system is present on the mesh.

Return type:

pyvista.MultiBlock

Raises:

  • ImportError – If the optional pyvista dependency is not installed.

  • TypeError – If mesh is not an SGMesh.

  • ValueError – If local-axis options or local-coordinate data are invalid.