feat: add export result as vtp files

doc/changelog.d/643.added.md

@@ -0,0 +1 @@
+Add export result as vtp files

src/ansys/speos/core/simulation.py

@@ -32,11 +32,10 @@
 import warnings
 
 from ansys.api.speos.job.v2 import job_pb2
+from ansys.api.speos.job.v2.job_pb2 import Result
 from ansys.api.speos.scene.v2 import scene_pb2 as messages
 from ansys.api.speos.simulation.v1 import simulation_template_pb2
 from ansys.speos.core.generic.general_methods import min_speos_version
-
-# from ansys.speos.core.geo_ref import GeoRef
 from ansys.speos.core.kernel.job import ProtoJob
 from ansys.speos.core.kernel.proto_message_utils import protobuf_message_to_str
 from ansys.speos.core.kernel.scene import ProtoScene
@@ -265,14 +264,57 @@ def export(self, export_path: Union[str, Path]) -> None:
                 "Selected simulation is not the first simulation feature, it can't be exported."
             )
 
-    def compute_CPU(self, threads_number: Optional[int] = None) -> List[job_pb2.Result]:
+    def _export_vtp(self) -> List[Path]:
+        """Export the simulation results into vtp files.
+
+        Returns
+        -------
+        List[Path]
+            list of vtp paths.
+
+        """
+        vtp_files = []
+        from ansys.speos.core import Face
+        from ansys.speos.core.sensor import Sensor3DIrradiance, SensorIrradiance
+        from ansys.speos.core.workflow.open_result import export_xm3_vtp, export_xmp_vtp
+
+        sensor_paths = self.get(key="sensor_paths")
+        for feature in self._project._features:
+            if feature._name not in sensor_paths:
+                continue
+            match feature:
+                case SensorIrradiance():
+                    xmp_data = feature.get(key="result_file_name")
+                    exported_vtp = export_xmp_vtp(self, xmp_data)
+                    vtp_files.append(exported_vtp)
+                case Sensor3DIrradiance():
+                    xm3_data = feature.get(key="result_file_name")
+                    geo_paths = feature.get(key="geo_paths")
+                    geos_faces = [
+                        self._project.find(name=geo_path, feature_type=Face)[0]._face
+                        for geo_path in geo_paths
+                    ]
+                    exported_vtp = export_xm3_vtp(self, geos_faces, xm3_data)
+                    vtp_files.append(exported_vtp)
+                case _:
+                    warnings.warn(
+                        "feature {} result currently not supported".format(feature._name),
+                        stacklevel=2,
+                    )
+        return vtp_files
+
+    def compute_CPU(
+        self, threads_number: Optional[int] = None, export_vtp: Optional[bool] = False
+    ) -> tuple[list[Result], list[Path]] | list[Result]:
         """Compute the simulation on CPU.
 
         Parameters
         ----------
         threads_number : int, optional
             The number of threads used.
             By default, ``None``, means the number of processor available.
+        export_vtp: bool, optional
+            True to generate vtp from the simulation results.
 
         Returns
         -------
@@ -287,18 +329,31 @@ def compute_CPU(self, threads_number: Optional[int] = None) -> List[job_pb2.Resu
             )
 
         self.result_list = self._run_job()
+        if export_vtp:
+            vtp_files = self._export_vtp()
+            return self.result_list, vtp_files
         return self.result_list
 
-    def compute_GPU(self) -> List[job_pb2.Result]:
+    def compute_GPU(
+        self, export_vtp: Optional[bool] = False
+    ) -> tuple[list[Result], list[Path]] | list[Result]:
         """Compute the simulation on GPU.
 
+        Parameters
+        ----------
+        export_vtp: bool, optional
+            True to generate vtp from the simulation results.
+
         Returns
         -------
         List[ansys.api.speos.job.v2.job_pb2.Result]
             List of simulation results.
         """
         self._job.job_type = ProtoJob.Type.GPU
         self.result_list = self._run_job()
+        if export_vtp:
+            vtp_files = self._export_vtp()
+            return self.result_list, vtp_files
         return self.result_list
 
     def _run_job(self) -> List[job_pb2.Result]: