pyedb 0.16.0__py3-none-any.whl → 0.18.0__py3-none-any.whl

pyedb/dotnet/edb_core/edb_data/hfss_pi_simulation_setup_data.py

@@ -1,460 +0,0 @@
-# Copyright (C) 2023 - 2024 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,
-# FITNE SS 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.
-
-from pyedb.dotnet.edb_core.general import convert_py_list_to_net_list
-from pyedb.dotnet.edb_core.sim_setup_data.data.sweep_data import SweepData
-from pyedb.dotnet.edb_core.utilities.simulation_setup import SimulationSetup
-from pyedb.generic.general_methods import generate_unique_name
-
-
-class HFSSPISimulationSetup(SimulationSetup):
-    """Manages EDB methods for HFSSPI simulation setup."""
-
-    def __init__(self, pedb, edb_object=None):
-        super().__init__(pedb, edb_object)
-        self._pedb = pedb
-        self._setup_type = "kHFSSPI"
-        self._edb_setup_info = None
-        self.logger = self._pedb.logger
-
-    def create(self, name=None):
-        """Create an HFSS setup."""
-        self._name = name
-        self._create(name)
-        return self
-
-    @property
-    def setup_type(self):
-        return self._setup_type
-
-    @property
-    def settings(self):
-        return HFSSPISimulationSettings(self._edb_setup_info, self._pedb)
-
-    @property
-    def enabled(self):
-        return self.settings.enabled
-
-    @enabled.setter
-    def enabled(self, value):
-        if isinstance(value, bool):
-            self.settings.enabled = value
-        else:
-            self.logger.error(f"Property enabled expects a boolean value while the provided value is {value}.")
-
-    @property
-    def position(self):
-        return self._edb_setup_info.Position
-
-    @position.setter
-    def position(self, value):
-        if isinstance(value, int):
-            self._edb_setup_info.Position = value
-        else:
-            self.logger.error(f"Property position expects an integer value while the provided value is {value}.")
-
-    def add_frequency_sweep(self, name=None, frequency_sweep=None):
-        """Add frequency sweep.
-
-        Parameters
-        ----------
-        name : str, optional
-            Name of the frequency sweep.
-        frequency_sweep : list, optional
-            List of frequency points.
-
-        Returns
-        -------
-        :class:`pyedb.dotnet.edb_core.edb_data.hfss_simulation_setup_data.EdbFrequencySweep`wheen succeeded, ``False``
-        when failed.
-
-        Examples
-        --------
-        >>> setup1 = edbapp.create_hfss_setup("setup1")
-        >>> setup1.add_frequency_sweep(frequency_sweep=[
-        ...                           ["linear count", "0", "1kHz", 1],
-        ...                           ["log scale", "1kHz", "0.1GHz", 10],
-        ...                           ["linear scale", "0.1GHz", "10GHz", "0.1GHz"],
-        ...                           ])
-        """
-        if name in self.frequency_sweeps:
-            self.logger.error("Frequency sweep with same name already defined.")
-            return False
-        if not name:
-            name = generate_unique_name("sweep")
-        return SweepData(self, frequency_sweep, name)
-
-
-class HFSSPISimulationSettings(object):
-    def __init__(self, edb_setup_info, pedb):
-        self._pedb = pedb
-        self.logger = self._pedb.logger
-        self._edb_setup_info = edb_setup_info
-        self._simulation_settings = edb_setup_info.SimulationSettings
-
-    @property
-    def auto_select_nets_for_simulation(self):
-        """Auto select nets for simulation.
-
-        Returns
-        -------
-            bool
-        """
-        return self._simulation_settings.AutoSelectNetsForSimulation
-
-    @auto_select_nets_for_simulation.setter
-    def auto_select_nets_for_simulation(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.AutoSelectNetsForSimulation = value
-        else:
-            self.logger.error(
-                "Property auto_select_nets_for_simulation expects a boolean "
-                f"value while the provided value is {value}."
-            )
-
-    @property
-    def enabled(self):
-        return self._simulation_settings.Enabled
-
-    @enabled.setter
-    def enabled(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.Enabled = value
-        else:
-            self.logger.error(f"Property enabled expects a boolean value while the provided value is {value}.")
-
-    @property
-    def ignore_dummy_nets_for_selected_nets(self):
-        """Auto select Nets for simulation
-
-        Returns
-        -------
-            bool
-        """
-        return self._simulation_settings.IgnoreDummyNetsForSelectedNets
-
-    @ignore_dummy_nets_for_selected_nets.setter
-    def ignore_dummy_nets_for_selected_nets(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.IgnoreDummyNetsForSelectedNets = value
-        else:
-            self.logger.error(
-                "Property ignore_dummy_nets_for_selected_nets expects a boolean "
-                f"value while the provided value is {value}."
-            )
-
-    @property
-    def ignore_small_holes(self):
-        """Ignore small holes choice.
-
-        Returns
-        -------
-            bool
-        """
-        return self._simulation_settings.IgnoreSmallHoles
-
-    @ignore_small_holes.setter
-    def ignore_small_holes(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.IgnoreSmallHoles = value
-        else:
-            self.logger.error(
-                f"Property ignore_small_holes expects a boolean value while the provided value is {value}."
-            )
-
-    @property
-    def ignore_small_holes_min_diameter(self):
-        """Min diameter to ignore small holes.
-
-        Returns
-        -------
-            str
-        """
-        return self._simulation_settings.IgnoreSmallHolesMinDiameter
-
-    @ignore_small_holes_min_diameter.setter
-    def ignore_small_holes_min_diameter(self, value):
-        self._simulation_settings.IgnoreSmallHolesMinDiameter = self._pedb.edb_value(value).ToString()
-
-    @property
-    def improved_loss_model(self):
-        """Improved Loss Model on power ground nets option.
-
-        Returns
-        -------
-            str
-            ``Level1``, ``Level2``, ``Level3``
-        """
-        return self._simulation_settings.ImprovedLossModel
-
-    @improved_loss_model.setter
-    def improved_loss_model(self, value):
-        expected_values = ["Level1", "Level2", "Level3"]
-        if isinstance(value, str) and value in expected_values:
-            self._simulation_settings.ImprovedLossModel = value
-        else:
-            self.logger.error(
-                "Property improved_loss_model expects a string value among "
-                f"'Level1', 'Level2' or 'Level3' while the provided value is {value}."
-            )
-
-    @property
-    def include_enhanced_bond_wire_modeling(self):
-        """Enhance Bond wire modeling.
-
-        Returns
-        -------
-            bool
-        """
-        return self._simulation_settings.IncludeEnhancedBondWireModeling
-
-    @include_enhanced_bond_wire_modeling.setter
-    def include_enhanced_bond_wire_modeling(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.IncludeEnhancedBondWireModeling = value
-        else:
-            self.logger.error(
-                "Property include_enhanced_bond_wire_modeling expects a "
-                f"boolean value while the provided value is {value}."
-            )
-
-    @property
-    def include_nets(self):
-        """Add Additional Nets for simulation.
-
-        Returns
-        -------
-            [str]
-            List of net name.
-        """
-        return list(self._simulation_settings.IncludeNets)
-
-    @include_nets.setter
-    def include_nets(self, value):
-        if isinstance(value, str):
-            value = [value]
-        if isinstance(value, list):
-            self._simulation_settings.IncludeNets = convert_py_list_to_net_list(value)
-        else:
-            self.logger.error(
-                f"Property include_nets expects a string or list of string while the provided value is {value}."
-            )
-
-    @property
-    def min_plane_area_to_mesh(self):
-        """The minimum area below which geometry is ignored.
-
-        Returns
-        -------
-            str
-        """
-        return self._simulation_settings.MinPlaneAreaToMesh
-
-    @min_plane_area_to_mesh.setter
-    def min_plane_area_to_mesh(self, value):
-        self._simulation_settings.MinPlaneAreaToMesh = self._pedb.edb_value(value).ToString()
-
-    @property
-    def min_void_area_to_mesh(self):
-        """The minimum area below which voids are ignored.
-
-        Returns
-        -------
-            str
-        """
-        return self._simulation_settings.MinVoidAreaToMesh
-
-    @min_void_area_to_mesh.setter
-    def min_void_area_to_mesh(self, value):
-        self._simulation_settings.MinVoidAreaToMesh = self._pedb.edb_value(value).ToString()
-
-    @property
-    def model_type(self):
-        """Model Type setting.
-
-        Returns
-        -------
-            int
-        Model type: ``0``=RDL, ``1``=Package, ``2``=PCB
-        """
-        return self._simulation_settings.ModelType
-
-    @model_type.setter
-    def model_type(self, value):
-        if isinstance(value, int) and value in range(3):
-            self._simulation_settings.ModelType = value
-        else:
-            self.logger.error(
-                f"Property model_type expects an integer value among 0, 1 or 2 while the provided value is {value}."
-            )
-
-    @property
-    def perform_erc(self):
-        """Perform ERC
-
-        Returns
-        -------
-            bool
-        """
-        return self._simulation_settings.PerformERC
-
-    @perform_erc.setter
-    def perform_erc(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.PerformERC = value
-        else:
-            self.logger.error(f"Property perform_erc expects a boolean value while the provided value is {value}.")
-
-    @property
-    def pi_slider_pos(self):
-        """The Simulation Preference Slider setting
-
-        Returns
-        -------
-            int
-        Model type: ``0``= balanced, ``1``=Accuracy.
-        """
-        return self._simulation_settings.PISliderPos
-
-    @pi_slider_pos.setter
-    def pi_slider_pos(self, value):
-        if isinstance(value, int) and value in range(2):
-            self._simulation_settings.PISliderPos = value
-        else:
-            self.logger.error(
-                f"Property pi_slider_pos expects an integer value among 0 or 1 while the provided value is {value}."
-            )
-
-    @property
-    def rms_surface_roughness(self):
-        """RMS Surface Roughness setting
-
-        Returns
-        -------
-            str
-        """
-        return self._simulation_settings.RMSSurfaceRoughness
-
-    @rms_surface_roughness.setter
-    def rms_surface_roughness(self, value):
-        self._simulation_settings.RMSSurfaceRoughness = self._pedb.edb_value(value).ToString()
-
-    @property
-    def signal_nets_conductor_modeling(self):
-        """Conductor Modeling
-
-        Returns
-        -------
-            str
-        Value: ``"MeshInside"`` or ``"ImpedanceBoundary"``.
-        """
-        return self._simulation_settings.SignalNetsConductorModeling
-
-    @signal_nets_conductor_modeling.setter
-    def signal_nets_conductor_modeling(self, value):
-        expected_values = ["MeshInside", "ImpedanceBoundary"]
-        if isinstance(value, str) and value in expected_values:
-            self._simulation_settings.SignalNetsConductorModeling = value
-        else:
-            self.logger.error(
-                "Property signal_nets_conductor_modeling expects a string value among "
-                f"'MeshInside' or 'ImpedanceBoundary' while the provided value is {value}."
-            )
-
-    @property
-    def signal_nets_error_tolerance(self):
-        """Error Tolerance
-
-        Returns
-        -------
-            str
-        Value between 0.02 and 1.
-        """
-        return self._simulation_settings.SignalNetsErrorTolerance
-
-    @signal_nets_error_tolerance.setter
-    def signal_nets_error_tolerance(self, value):
-        self._simulation_settings.SignalNetsErrorTolerance = self._pedb.edb_value(value).ToString()
-
-    @property
-    def signal_nets_include_improved_dielectric_fill_refinement(self):
-        return self._simulation_settings.SignalNetsIncludeImprovedDielectricFillRefinement
-
-    @signal_nets_include_improved_dielectric_fill_refinement.setter
-    def signal_nets_include_improved_dielectric_fill_refinement(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.SignalNetsIncludeImprovedDielectricFillRefinement = value
-        else:
-            self.logger.error(
-                "Property signal_nets_include_improved_dielectric_fill_refinement "
-                f"expects a boolean value while the provided value is {value}."
-            )
-
-    @property
-    def signal_nets_include_improved_loss_handling(self):
-        """Improved Dielectric Fill Refinement choice.
-
-        Returns
-        -------
-            bool
-        """
-        return self._simulation_settings.SignalNetsIncludeImprovedLossHandling
-
-    @signal_nets_include_improved_loss_handling.setter
-    def signal_nets_include_improved_loss_handling(self, value):
-        if isinstance(value, bool):
-            self._simulation_settings.SignalNetsIncludeImprovedLossHandling = value
-        else:
-            self.logger.error(
-                "Property signal_nets_include_improved_loss_handling "
-                f"expects a boolean value while the provided value is {value}."
-            )
-
-    @property
-    def snap_length_threshold(self):
-        return self._simulation_settings.SnapLengthThreshold
-
-    @snap_length_threshold.setter
-    def snap_length_threshold(self, value):
-        self._simulation_settings.SnapLengthThreshold = self._pedb.edb_value(value).ToString()
-
-    @property
-    def surface_roughness_model(self):
-        """Chosen Model setting
-
-        Returns
-        -------
-            str
-        Model allowed, ``"None"``, ``"Exponential"`` or ``"Hammerstad"``.
-        """
-        return self._simulation_settings.SurfaceRoughnessModel
-
-    @surface_roughness_model.setter
-    def surface_roughness_model(self, value):
-        expected_values = ["None", "Exponential", "Hammerstad"]
-        if isinstance(value, str) and value in expected_values:
-            self._simulation_settings.SurfaceRoughnessModel = value
-        else:
-            self.logger.error(
-                "Property surface_roughness_model expects a string value among "
-                f"'None', 'Exponential' or 'Hammerstad' while the provided value is {value}."
-            )

pyedb/dotnet/edb_core/edb_data/primitives_data.py

@@ -558,6 +558,15 @@ class EDBPrimitives(Primitive):
                 dist = GeometryOperators.points_distance(mid_point, point)
         return [out.X.ToDouble(), out.Y.ToDouble()]
 
+    @property
+    def voids(self):
+        """:obj:`list` of :class:`Primitive <ansys.edb.primitive.Primitive>`: List of void\
+        primitive objects inside the primitive.
+
+        Read-Only.
+        """
+        return [cast(void, self._app) for void in self.prim_obj.Voids]
+
     @property
     def arcs(self):
         """Get the Primitive Arc Data."""
@@ -896,6 +905,35 @@ class EdbPolygon(EDBPrimitives, PolygonDotNet):
             return cloned_poly
         return False
 
+    @property
+    def has_self_intersections(self):
+        """Check if Polygon has self intersections.
+
+        Returns
+        -------
+        bool
+        """
+        return self.polygon_data.edb_api.HasSelfIntersections()
+
+    def fix_self_intersections(self):
+        """Remove self intersections if they exists.
+
+        Returns
+        -------
+        list
+            All new polygons created from the removal operation.
+        """
+        new_polys = []
+        if self.has_self_intersections:
+            new_polygons = list(self.polygon_data.edb_api.RemoveSelfIntersections())
+            self.polygon_data = new_polygons[0]
+            for p in new_polygons[1:]:
+                cloned_poly = self._app.edb_api.cell.primitive.polygon.create(
+                    self._app.active_layout, self.layer_name, self.net, p
+                )
+                new_polys.append(cloned_poly)
+        return new_polys
+
     def duplicate_across_layers(self, layers):
         """Duplicate across layer a primitive object.
 
@@ -989,44 +1027,6 @@ class EdbPolygon(EDBPrimitives, PolygonDotNet):
                 return self.api_object.SetPolygonData(polygon_data)
         return False
 
-    def scale(self, factor, center=None):
-        """Scales the polygon relative to a center point by a factor.
-
-        Parameters
-        ----------
-        factor : float
-            Scaling factor.
-        center : List of float or str [x,y], optional
-            If None scaling is done from polygon center.
-
-        Returns
-        -------
-        bool
-           ``True`` when successful, ``False`` when failed.
-
-        Examples
-        --------
-        >>> edbapp = pyaedt.Edb("myproject.aedb")
-        >>> top_layer_polygon = [poly for poly in edbapp.modeler.polygons if poly.layer_name == "Top Layer"]
-        >>> for polygon in top_layer_polygon:
-        >>>     polygon.scale(factor=2)
-        """
-        if not isinstance(factor, str):
-            factor = float(factor)
-            polygon_data = self._edb.Geometry.PolygonData.CreateFromArcs(self.polygon_data.edb_api.GetArcData(), True)
-            if not center:
-                center = polygon_data.GetBoundingCircleCenter()
-                if center:
-                    polygon_data.Scale(factor, center)
-                    return self.api_object.SetPolygonData(polygon_data)
-            elif isinstance(center, list) and len(center) == 2:
-                center = self._edb.Geometry.PointData(
-                    self._edb.Utility.Value(center[0]), self._edb.Utility.Value(center[1])
-                )
-                polygon_data.Scale(factor, center)
-                return self.api_object.SetPolygonData(polygon_data)
-        return False
-
     def move_layer(self, layer):
         """Move polygon to given layer.
 

pyedb/dotnet/edb_core/edb_data/raptor_x_simulation_setup_data.py

@@ -38,7 +38,7 @@ class RaptorXSimulationSetup(SimulationSetup):
     def create(self, name=None):
         """Create an HFSS setup."""
         self._name = name
-        self._create(name)
+        self._create(name, simulation_setup_type=self._setup_type)
         return self
 
     @property

pyedb/dotnet/edb_core/layout.py

@@ -94,6 +94,27 @@ class EdbLayout(object):
         """
         return self._pedb.stackup.layers
 
+    def get_primitive(self, primitive_id):
+        """Retrieve primitive from give id.
+
+        Parameters
+        ----------
+        primitive_id : int
+            Primitive id.
+
+        Returns
+        -------
+        list of :class:`pyedb.dotnet.edb_core.edb_data.primitives_data.EDBPrimitives`
+            List of primitives.
+        """
+        for p in self._layout.primitives:
+            if p.id == primitive_id:
+                return p
+        for p in self._layout.primitives:
+            for v in p.voids:
+                if v.id == primitive_id:
+                    return v
+
     @property
     def primitives(self):
         """Primitives.

pyedb/dotnet/edb_core/layout_validation.py

@@ -258,6 +258,32 @@ class LayoutValidation:
 
         return new_nets
 
+    def fix_self_intersections(self, net_list=None):
+        """Find and fix self intersections from a given netlist.
+
+        Parameters
+        ----------
+        net_list : str, list, optional
+            List of nets on which check disjoints. If `None` is provided then the algorithm will loop on all nets.
+
+        Returns
+        -------
+        bool
+        """
+        if not net_list:
+            net_list = list(self._pedb.nets.keys())
+        elif isinstance(net_list, str):
+            net_list = [net_list]
+        new_prims = []
+        for prim in self._pedb.modeler.polygons:
+            if prim.net_name in net_list:
+                new_prims.extend(prim.fix_self_intersections())
+        if new_prims:
+            self._pedb._logger.info("Self-intersections detected and removed.")
+        else:
+            self._pedb._logger.info("Self-intersection not found.")
+        return True
+
     def illegal_net_names(self, fix=False):
         """Find and fix illegal net names."""
         pattern = r"[\(\)\\\/:;*?<>\'\"|`~$]"

pyedb/dotnet/edb_core/nets.py

@@ -38,7 +38,7 @@ class EdbNets(object):
 
     Examples
     --------
-    >>> from pyedb.dotnet.edb import Edb
+    >>> from pyedb import Edb
     >>> edbapp = Edb("myaedbfolder", edbversion="2021.2")
     >>> edb_nets = edbapp.nets
     """

pyedb/dotnet/edb_core/sim_setup_data/data/sim_setup_info.py

@@ -46,7 +46,7 @@ class SimSetupInfo:
             "kAnalysisOption": None,
             "kSIwaveDCIR": self._pedb.simsetupdata.SIwave.SIWDCIRSimulationSettings,
             "kSIwaveEMI": None,
-            "kHFSSPI": None,
+            "kHFSSPI": self._pedb.simsetupdata.HFSSPISimulationSettings,
             "kDDRwizard": None,
             "kQ3D": None,
             "kNumSetupTypes": None,