pyedb 0.38.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

pyedb/grpc/database/definition/n_port_component_model.py

@@ -0,0 +1,34 @@
+# 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,
+# 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.
+
+
+from ansys.edb.core.definition.component_model import (
+    NPortComponentModel as GrpcNPortComponentModel,
+)
+
+
+class NPortComponentModel(GrpcNPortComponentModel):
+    """Class managing :class:`NPortComponentModel <ansys.edb.core.definition.component_model.NPortComponentModel>`"""
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(edb_object)
+        self._pedb = pedb

pyedb/grpc/database/definition/package_def.py

@@ -0,0 +1,227 @@
+# 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,
+# 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.
+
+from ansys.edb.core.definition.package_def import PackageDef as GrpcPackageDef
+from ansys.edb.core.geometry.polygon_data import PolygonData as GrpcPolygonData
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+from pyedb.edb_logger import pyedb_logger
+from pyedb.grpc.database.utility.heat_sink import HeatSink
+
+
+class PackageDef(GrpcPackageDef):
+    """Manages EDB package definitions.
+
+    Parameters
+    ----------
+    pedb : :class:`Edb <pyedb.grpc.edb.Edb>`
+        Edb object.
+    edb_object : object
+    Edb PackageDef Object
+        component_part_name : str, optional
+        Part name of the component.
+    extent_bounding_box : list, optional
+        Bounding box defines the shape of the package. For example, [[0, 0], ["2mm", "2mm"]].
+
+    """
+
+    def __init__(self, pedb, edb_object=None, name=None, component_part_name=None, extent_bounding_box=None):
+        super(GrpcPackageDef, self).__init__(edb_object.msg)
+        self._pedb = pedb
+        self._edb_object = edb_object
+        self._heat_sink = None
+        if self._edb_object is None and name is not None:
+            self._edb_object = self.__create_from_name(name, component_part_name, extent_bounding_box)
+
+    def __create_from_name(self, name, component_part_name=None, extent_bounding_box=None):
+        """Create a package definition.
+
+        Parameters
+        ----------
+        name: str
+            Name of the package definition.
+
+        Returns
+        -------
+        edb_object: object
+            EDB PackageDef Object
+        """
+        edb_object = GrpcPackageDef.create(self._pedb.active_db, name)
+        if component_part_name:
+            x_pt1, y_pt1, x_pt2, y_pt2 = list(
+                self._pedb.components.definitions[component_part_name].components.values()
+            )[0].bounding_box
+            x_mid = (x_pt1 + x_pt2) / 2
+            y_mid = (y_pt1 + y_pt2) / 2
+            bbox = [[y_pt1 - y_mid, x_pt1 - x_mid], [y_pt2 - y_mid, x_pt2 - x_mid]]
+        else:
+            bbox = extent_bounding_box
+        if bbox is None:
+            pyedb_logger.warning(
+                "Package creation uses bounding box but it cannot be inferred. "
+                "Please set argument 'component_part_name' or 'extent_bounding_box'."
+            )
+        polygon_data = GrpcPolygonData(points=bbox)
+
+        self.exterior_boundary = polygon_data
+        return edb_object
+
+    @property
+    def exterior_boundary(self):
+        """Get the exterior boundary of a package definition.
+
+        Returns
+        -------
+        :class:`PolygonData <ansys.edb.core.geometry.polygon_data.PolygonData>`
+
+        """
+        return GrpcPolygonData(super().exterior_boundary.points)
+
+    @exterior_boundary.setter
+    def exterior_boundary(self, value):
+        super(PackageDef, self.__class__).exterior_boundary.__set__(self, value)
+
+    @property
+    def maximum_power(self):
+        """Maximum power of the package.
+
+        Returns
+        -------
+        float
+            maximum power value.
+        """
+        return super().maximum_power.value
+
+    @maximum_power.setter
+    def maximum_power(self, value):
+        super(PackageDef, self.__class__).maximum_power.__set__(self, GrpcValue(value))
+
+    @property
+    def therm_cond(self):
+        """Thermal conductivity of the package.
+
+        Returns
+        -------
+        float
+            Thermal conductivity value.
+
+        """
+        return super().thermal_conductivity.value
+
+    @therm_cond.setter
+    def therm_cond(self, value):
+        self.therm_cond = GrpcValue(value)
+        super(PackageDef, self.__class__).thermal_conductivity.__set__(self, GrpcValue(value))
+
+    @property
+    def theta_jb(self):
+        """Theta Junction-to-Board of the package.
+
+        Returns
+        -------
+        float
+            Theta jb value.
+        """
+        return super().theta_jb.value
+
+    @theta_jb.setter
+    def theta_jb(self, value):
+        super(PackageDef, self.__class__).theta_jb.__set__(self, GrpcValue(value))
+
+    @property
+    def theta_jc(self):
+        """Theta Junction-to-Case of the package.
+
+        Returns
+        -------
+        float
+            Theta jc value.
+        """
+        return super().theta_jc.value
+
+    @theta_jc.setter
+    def theta_jc(self, value):
+        super(PackageDef, self.__class__).theta_jc.__set__(self, GrpcValue(value))
+
+    @property
+    def height(self):
+        """Height of the package.
+
+        Returns
+        -------
+        float
+            Height value.
+        """
+        return super().height.value
+
+    @height.setter
+    def height(self, value):
+        super(PackageDef, self.__class__).height.__set__(self, GrpcValue(value))
+
+    @property
+    def heat_sink(self):
+        """Package heat sink.
+
+        Returns
+        -------
+        :class:`HeatSink <pyedb.grpc.database.utility.heat_sink.HeatSink>`
+            HeatSink object.
+        """
+        return HeatSink(self._pedb, super().heat_sink)
+
+    def set_heatsink(self, fin_base_height, fin_height, fin_orientation, fin_spacing, fin_thickness):
+        """Set Heat sink.
+        Parameters
+        ----------
+        fin_base_height : str, float
+            Fin base height.
+        fin_height : str, float
+            Fin height.
+        fin_orientation : str
+            Fin orientation. Supported values, `x_oriented`, `y_oriented`.
+        fin_spacing : str, float
+            Fin spacing.
+        fin_thickness : str, float
+            Fin thickness.
+        """
+        from ansys.edb.core.utility.heat_sink import (
+            HeatSinkFinOrientation as GrpcHeatSinkFinOrientation,
+        )
+        from ansys.edb.core.utility.heat_sink import HeatSink as GrpcHeatSink
+
+        if fin_orientation == "x_oriented":
+            fin_orientation = GrpcHeatSinkFinOrientation.X_ORIENTED
+        elif fin_orientation == "y_oriented":
+            fin_orientation = GrpcHeatSinkFinOrientation.Y_ORIENTED
+        else:
+            fin_orientation = GrpcHeatSinkFinOrientation.OTHER_ORIENTED
+        super(PackageDef, self.__class__).heat_sink.__set__(
+            self,
+            GrpcHeatSink(
+                GrpcValue(fin_thickness),
+                GrpcValue(fin_spacing),
+                GrpcValue(fin_base_height),
+                GrpcValue(fin_height),
+                fin_orientation,
+            ),
+        )
+        return self.heat_sink