Add Nearfield into mixin

Author: Samuelopez-ansys

src/ansys/aedt/core/hfss.py

@@ -27,6 +27,7 @@
 import math
 from pathlib import Path
 import tempfile
+from typing import Optional
 from typing import Union
 import warnings
 
@@ -5574,19 +5575,19 @@ def insert_infinite_sphere(
     @pyaedt_function_handler()
     def insert_near_field_sphere(
         self,
-        radius=20,
+        radius: Union[float, int, str] = 20,
         radius_units="mm",
-        x_start=0,
-        x_stop=180,
-        x_step=10,
-        y_start=0,
-        y_stop=180,
-        y_step=10,
-        angle_units="deg",
-        custom_radiation_faces=None,
-        custom_coordinate_system=None,
-        name=None,
-    ):
+        x_start: Union[float, int, str] = 0,
+        x_stop: Union[float, int, str] = 180,
+        x_step: Union[float, int, str] = 10,
+        y_start: Union[float, int, str] = 0,
+        y_stop: Union[float, int, str] = 180,
+        y_step: Union[float, int, str] = 10,
+        angle_units: str = "deg",
+        custom_radiation_faces: Optional[str] = None,
+        custom_coordinate_system: Optional[str] = None,
+        name: Optional[str] = None,
+    ) -> NearFieldSetup:
         """Create a near field sphere.
 
         .. note::
@@ -5648,26 +5649,22 @@ def insert_near_field_sphere(
             props["CoordSystem"] = custom_coordinate_system
         else:
             props["CoordSystem"] = ""
-        bound = NearFieldSetup(self, name, props, "NearFieldSphere")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        return False
+        return self._create_field_setup(name, props, "NearFieldSphere")
 
     @pyaedt_function_handler()
     def insert_near_field_box(
         self,
-        u_length=20,
-        u_samples=21,
-        v_length=20,
-        v_samples=21,
-        w_length=20,
-        w_samples=21,
-        units="mm",
-        custom_radiation_faces=None,
-        custom_coordinate_system=None,
-        name=None,
-    ):
+        u_length: Union[float, int, str] = 20,
+        u_samples: Union[float, int, str] = 21,
+        v_length: Union[float, int, str] = 20,
+        v_samples: Union[float, int, str] = 21,
+        w_length: Union[float, int, str] = 20,
+        w_samples: Union[float, int, str] = 21,
+        units: str = "mm",
+        custom_radiation_faces: Optional[str] = None,
+        custom_coordinate_system: Optional[str] = None,
+        name: Optional[str] = None,
+    ) -> NearFieldSetup:
         """Create a near field box.
 
         .. note::
@@ -5723,24 +5720,20 @@ def insert_near_field_box(
             props["CoordSystem"] = custom_coordinate_system
         else:
             props["CoordSystem"] = "Global"
-        bound = NearFieldSetup(self, name, props, "NearFieldBox")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        return False
+        return self._create_field_setup(name, props, "NearFieldBox")
 
     @pyaedt_function_handler()
     def insert_near_field_rectangle(
         self,
-        u_length=20,
-        u_samples=21,
-        v_length=20,
-        v_samples=21,
-        units="mm",
-        custom_radiation_faces=None,
-        custom_coordinate_system=None,
-        name=None,
-    ):
+        u_length: Union[float, int, str] = 20,
+        u_samples: Union[float, int, str] = 21,
+        v_length: Union[float, int, str] = 20,
+        v_samples: Union[float, int, str] = 21,
+        units: str = "mm",
+        custom_radiation_faces: Optional[str] = None,
+        custom_coordinate_system: Optional[str] = None,
+        name: Optional[str] = None,
+    ) -> NearFieldSetup:
         """Create a near field rectangle.
 
         .. note::
@@ -5790,20 +5783,17 @@ def insert_near_field_rectangle(
             props["CoordSystem"] = custom_coordinate_system
         else:
             props["CoordSystem"] = "Global"
-        bound = NearFieldSetup(self, name, props, "NearFieldRectangle")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        return False
+
+        return self._create_field_setup(name, props, "NearFieldRectangle")
 
     @pyaedt_function_handler(line="assignment")
     def insert_near_field_line(
         self,
-        assignment,
-        points=1000,
-        custom_radiation_faces=None,
-        name=None,
-    ):
+        assignment: str,
+        points: Union[float, str] = 1000,
+        custom_radiation_faces: Optional[str] = None,
+        name: str = None,
+    ) -> NearFieldSetup:
         """Create a near field line.
 
         .. note::
@@ -5830,6 +5820,7 @@ def insert_near_field_line(
             name = generate_unique_name("Line")
 
         props = dict({"UseCustomRadiationSurface": custom_radiation_faces is not None})
+
         if custom_radiation_faces:
             props["CustomRadiationSurface"] = custom_radiation_faces
         else:
@@ -5838,19 +5829,15 @@ def insert_near_field_line(
         props["NumPts"] = points
         props["Line"] = assignment
 
-        bound = NearFieldSetup(self, name, props, "NearFieldLine")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        return False
+        return self._create_field_setup(name, props, "NearFieldLine")
 
     @pyaedt_function_handler()
     def insert_near_field_points(
         self,
         input_file: Union[str, Path] = None,
-        coordinate_system="Global",
-        name=None,
-    ):
+        coordinate_system: str = "Global",
+        name: Optional[str] = None,
+    ) -> NearFieldSetup:
         """Create a near field line.
 
         .. note::
@@ -5880,11 +5867,7 @@ def insert_near_field_points(
         props["CoordSystem"] = coordinate_system
         props["PointListFile"] = str(point_file)
 
-        bound = NearFieldSetup(self, name, props, "NearFieldPoints")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        return False
+        return self._create_field_setup(name, props, "NearFieldPoints")
 
     @pyaedt_function_handler()
     def set_sbr_current_sources_options(self, conformance=False, thin_sources=False, power_fraction=0.95):

src/ansys/aedt/core/mixins.py

@@ -26,6 +26,7 @@
 from ansys.aedt.core.internal.errors import AEDTRuntimeError
 from ansys.aedt.core.internal.errors import GrpcApiError
 from ansys.aedt.core.modules.boundary.common import BoundaryObject
+from ansys.aedt.core.modules.boundary.hfss_boundary import NearFieldSetup
 
 
 class CreateBoundaryMixin:
@@ -78,3 +79,33 @@ def _create_boundary(self, name, props, boundary_type):
             return bound
         except GrpcApiError as e:
             raise AEDTRuntimeError(f"Failed to create boundary {boundary_type} {name}") from e
+
+    @pyaedt_function_handler()
+    def _create_field_setup(self, name, props, boundary_type):
+        """Create a field setup.
+
+        Parameters
+        ----------
+        name : str
+            Name of the boundary.
+        props : list or dict
+            List of properties for the boundary.
+        boundary_type :
+            Type of the boundary.
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modules.boundary.hfss_boundary.NearFieldSetup`
+            Boundary object.
+
+        """
+        try:
+            bound = NearFieldSetup(self, name, props, boundary_type)
+            if not bound.create():
+                raise AEDTRuntimeError(f"Failed to create {boundary_type} {name}")
+
+            self.field_setups.append(bound)
+            self.logger.info(f"Field setup {boundary_type} {name} has been created.")
+            return bound
+        except GrpcApiError as e:  # pragma: no cover
+            raise AEDTRuntimeError(f"Failed to create boundary {boundary_type} {name}") from e

src/ansys/aedt/core/q3d.py

@@ -2362,11 +2362,7 @@ def insert_em_field_line(
             "Line": assignment,
         }
 
-        bound = NearFieldSetup(self, name, props, "NearFieldLine")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        raise AEDTRuntimeError("Failed to create EM field line.")  # pragma: no cover
+        return self._create_field_setup(name, props, "NearFieldLine")
 
     @pyaedt_function_handler()
     @min_aedt_version("2025.1")
@@ -2424,11 +2420,8 @@ def insert_em_field_rectangle(
             props["CoordSystem"] = custom_coordinate_system
         else:
             props["CoordSystem"] = "Global"
-        bound = NearFieldSetup(self, name, props, "NearFieldRectangle")
-        if bound.create():
-            self.field_setups.append(bound)
-            return bound
-        raise AEDTRuntimeError("Failed to create EM field rectangle.")  # pragma: no cover
+
+        return self._create_field_setup(name, props, "NearFieldRectangle")
 
     @pyaedt_function_handler()
     @min_aedt_version("2025.1")
@@ -2495,10 +2488,7 @@ def insert_em_field_box(
         else:
             props["CoordSystem"] = "Global"
 
-        bound = NearFieldSetup(self, name, props, "NearFieldBox")
-        if bound.create():
-            return bound
-        raise AEDTRuntimeError("Failed to create EM field box.")  # pragma: no cover
+        return self._create_field_setup(name, props, "NearFieldBox")
 
     @pyaedt_function_handler()
     @min_aedt_version("2025.1")
@@ -2571,10 +2561,8 @@ def insert_em_field_sphere(
             props["CoordSystem"] = custom_coordinate_system
         else:
             props["CoordSystem"] = ""
-        bound = NearFieldSetup(self, name, props, "NearFieldSphere")
-        if bound.create():
-            return bound
-        raise AEDTRuntimeError("Failed to create EM field sphere.")  # pragma: no cover
+
+        return self._create_field_setup(name, props, "NearFieldSphere")
 
 
 class Q2d(QExtractor, CreateBoundaryMixin):