feat: Add VTKHDF files management (#419)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: AlejandroFernandezLuces

doc/changelog.d/419.miscellaneous.md

@@ -0,0 +1 @@
+Feat: Add VTKHDF files management

src/ansys/tools/visualization_interface/utils/vtkhdf_converter.py

@@ -0,0 +1,117 @@
+# Copyright (C) 2024 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Utils module for VTKHDF management."""
+from pathlib import Path
+from typing import Union
+
+import pyvista as pv
+import vtk
+from vtkmodules.vtkIOHDF import vtkHDFWriter
+
+
+def pd_to_vtkhdf(pd: pv.PolyData, output_vtkhdf_file: Union[str, Path]) -> Path:
+    """Write the PyVista PolyData directly to a VTKHDF file.
+
+    Parameters
+    ----------
+    pd : pv.PolyData
+        The PyVista PolyData to be written.
+    output_vtkhdf_file : Union[str, Path]
+        The output VTKHDF file path.
+
+    Returns
+    -------
+    Path
+        The path to the saved VTKHDF file.
+    """
+    writer = vtkHDFWriter()
+    writer.SetFileName(str(output_vtkhdf_file))
+    writer.SetInputDataObject(pd)
+    writer.Write()
+    return Path(output_vtkhdf_file)
+
+
+def vtkhdf_to_pd(input_vtkhdf_file: Union[str, Path]) -> pv.PolyData:
+    """Read a VTKHDF file and convert it to PyVista PolyData.
+
+    Parameters
+    ----------
+    input_vtkhdf_file : Union[str, Path]
+        The input VTKHDF file path.
+
+    Returns
+    -------
+    pv.PolyData
+        The converted PyVista PolyData.
+    """
+    reader = vtk.vtkHDFReader()
+    reader.SetFileName(str(input_vtkhdf_file))
+    reader.Update()
+    # Convert VTK object directly to PyVista PolyData
+    pd = pv.wrap(reader.GetOutput())
+
+    return pd
+
+
+def ug_to_vtkhdf(ug: pv.UnstructuredGrid, output_vtkhdf_file: Union[str, Path]) -> Path:
+    """Write the PyVista UnstructuredGrid directly to a VTKHDF file.
+
+    Parameters
+    ----------
+    ug : pv.UnstructuredGrid
+        The PyVista UnstructuredGrid to be written.
+    output_vtkhdf_file : Union[str, Path]
+        The output VTKHDF file path.
+
+    Returns
+    -------
+    Path
+        The path to the saved VTKHDF file.
+    """
+    writer = vtkHDFWriter()
+    writer.SetFileName(str(output_vtkhdf_file))
+    writer.SetInputDataObject(ug)
+    writer.Write()
+    return Path(output_vtkhdf_file)
+
+
+def vtkhdf_to_ug(input_vtkhdf_file: Union[str, Path]) -> pv.UnstructuredGrid:
+    """Read a VTKHDF file and convert it to PyVista UnstructuredGrid.
+
+    Parameters
+    ----------
+    input_vtkhdf_file : Union[str, Path]
+        The input VTKHDF file path.
+
+    Returns
+    -------
+    pv.UnstructuredGrid
+        The converted PyVista UnstructuredGrid.
+    """
+    reader = vtk.vtkHDFReader()
+    reader.SetFileName(str(input_vtkhdf_file))
+    reader.Update()
+    # Convert VTK object directly to PyVista UnstructuredGrid
+    ug = pv.wrap(reader.GetOutput())
+
+    return ug

tests/test_vtkhdf_converter.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+
+# Copyright (C) 2024 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Test script to verify the VTKHDF converter functions work correctly."""
+
+import pyvista as pv
+from pyvista import examples
+
+from ansys.tools.visualization_interface.utils.vtkhdf_converter import (
+    pd_to_vtkhdf,
+    ug_to_vtkhdf,
+    vtkhdf_to_pd,
+    vtkhdf_to_ug,
+)
+
+
+def test_pd_conversion(tmp_path):
+    """Test PolyData to VTKHDF and back conversion."""
+    print("Testing PolyData conversion...")
+
+    # Create a sphere
+    original_sphere = pv.Sphere()
+
+    # Create temporary file path
+    temp_file = tmp_path / "test_pd.vtkhdf"
+
+    # Convert to VTKHDF using Path object
+    saved_path = pd_to_vtkhdf(original_sphere, temp_file)
+
+    # Verify the returned path matches the input
+    assert saved_path == temp_file, "Returned path should match input path"
+
+    # Convert back using Path object
+    loaded_sphere = vtkhdf_to_pd(temp_file)
+
+    # Verify they have the same number of points and cells
+    assert original_sphere.n_points == loaded_sphere.n_points, "Point count mismatch"
+    assert original_sphere.n_cells == loaded_sphere.n_cells, "Cell count mismatch"
+
+def test_ug_conversion(tmp_path):
+    """Test UnstructuredGrid to VTKHDF and back conversion."""
+    # Create an unstructured grid
+    original_grid = pv.UnstructuredGrid(examples.hexbeamfile)
+
+    # Create temporary file path
+    temp_file = tmp_path / "test_ug.vtkhdf"
+
+    # Convert to VTKHDF using Path object
+    saved_path = ug_to_vtkhdf(original_grid, temp_file)
+
+    # Verify the returned path matches the input
+    assert saved_path == temp_file, "Returned path should match input path"
+
+    # Convert back using Path object
+    loaded_grid = vtkhdf_to_ug(temp_file)
+
+    # Verify they have the same number of points and cells
+    assert original_grid.n_points == loaded_grid.n_points, "Point count mismatch"
+    assert original_grid.n_cells == loaded_grid.n_cells, "Cell count mismatch"