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

pyedb/grpc/database/terminal/bundle_terminal.py

@@ -0,0 +1,218 @@
+# 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.terminal.terminals import (
+    SourceTermToGroundType as GrpcSourceTermToGroundType,
+)
+from ansys.edb.core.terminal.terminals import BundleTerminal as GrpcBundleTerminal
+from ansys.edb.core.terminal.terminals import HfssPIType as GrpcHfssPIType
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+from pyedb.grpc.database.hierarchy.component import Component
+from pyedb.grpc.database.layers.layer import Layer
+from pyedb.grpc.database.net.net import Net
+from pyedb.grpc.database.terminal.terminal import Terminal
+from pyedb.grpc.database.utility.rlc import Rlc
+
+
+class BundleTerminal(GrpcBundleTerminal):
+    """Manages bundle terminal properties.
+
+    Parameters
+    ----------
+    pedb : :class:`Edb <pyedb.grpc.edb.Edb>`
+        EDB object.
+    edb_object : :class:`BundleTerminal <ansys.edb.core.terminal.terminals.BundleTerminal>`
+        BundleTerminal instance from EDB.
+    """
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(edb_object)
+        self._pedb = pedb
+        self._edb_object = edb_object
+
+    def decouple(self):
+        """Ungroup a bundle of terminals.
+
+        Returns
+        -------
+        bool
+        """
+        return self.ungroup()
+
+    @property
+    def component(self):
+        """Component.
+
+        Returns
+        -------
+        :class:`Component <pyedb.grpc.database.hierarchy.component.Component`
+        """
+        return Component(self._pedb, self.component)
+
+    @property
+    def impedance(self):
+        """Impedance value.
+
+        Returns
+        -------
+        float
+            Impedance value.
+        """
+        return self.impedance.value
+
+    @impedance.setter
+    def impedance(self, value):
+        self.impedance = GrpcValue(value)
+
+    @property
+    def net(self):
+        """Returns Net object.
+
+        Returns
+        -------
+        :class:`Net <pyedb.grpc.database.net.net.Net>`
+        """
+        return Net(self._pedb, self.net)
+
+    @property
+    def hfss_pi_type(self):
+        """Returns HFSS PI type.
+
+        Returns
+        -------
+        str
+        """
+        return self.hfss_pi_type.name
+
+    @hfss_pi_type.setter
+    def hfss_pi_type(self, value):
+        if value.upper() == "DEFAULT":
+            self.hfss_pi_type = GrpcHfssPIType.DEFAULT
+        elif value.upper() == "COAXIAL_OPEN":
+            self.hfss_pi_type = GrpcHfssPIType.COAXIAL_OPEN
+        elif value.upper() == "COAXIAL_SHORTENED":
+            self.hfss_pi_type = GrpcHfssPIType.COAXIAL_SHORTENED
+        elif value.upper() == "GAP":
+            self.hfss_pi_type = GrpcHfssPIType.GAP
+        elif value.upper() == "LUMPED":
+            self.hfss_pi_type = GrpcHfssPIType.LUMPED
+
+    @property
+    def reference_layer(self):
+        """Returns reference layer.
+
+        Returns
+        -------
+        :class:`Layer <pyedb.grpc.database.layer.layer.Layer>`
+        """
+        return Layer(self._pedb, self.reference_layer)
+
+    @reference_layer.setter
+    def reference_layer(self, value):
+        if isinstance(value, Layer):
+            self.reference_layer = value._edb_object
+        elif isinstance(value, str):
+            self.reference_layer = self._pedb.stackup.signal_layer[value]._edb_object
+
+    @property
+    def reference_terminal(self):
+        """Returns reference terminal.
+
+        Returns
+        -------
+        :class:`Terminal <pyedb.grpc.database.terminal.terminal.Terminal>`
+        """
+        return Terminal(self._pedb, self.reference_terminal)
+
+    @reference_terminal.setter
+    def reference_terminal(self, value):
+        if isinstance(value, Terminal):
+            self.reference_terminal = value._edb_object
+
+    @property
+    def rlc_boundary_parameters(self):
+        """Returns Rlc parameters
+
+        Returns
+        -------
+        :class:`Rlc <pyedb.grpc.database.utility.rlc.Rlc>`
+        """
+        return Rlc(self._pedb, self.rlc)
+
+    @property
+    def source_amplitude(self):
+        """Returns source amplitude.
+
+        Returns
+        -------
+        float
+        """
+        return self.source_amplitude.value
+
+    @source_amplitude.setter
+    def source_amplitude(self, value):
+        self.source_amplitude = GrpcValue(value)
+
+    @property
+    def source_phase(self):
+        """Returns source phase.
+
+        Returns
+        -------
+        float
+        """
+        return self.source_phase.value
+
+    @source_phase.setter
+    def source_phase(self, value):
+        self.source_phase = GrpcValue(value)
+
+    @property
+    def term_to_ground(self):
+        """Returns terminal to ground.
+
+        Returns
+        -------
+        str
+            Terminal name.
+        """
+        return self.term_to_ground.name
+
+    @term_to_ground.setter
+    def term_to_ground(self, value):
+        if value.upper() == "NO_GROUND":
+            self.term_to_ground = GrpcSourceTermToGroundType.NO_GROUND
+        elif value.upper() == "NEGATIVE":
+            self.term_to_ground = GrpcSourceTermToGroundType.NEGATIVE
+        elif value.upper() == "POSITIVE":
+            self.term_to_ground = GrpcSourceTermToGroundType.POSITIVE
+
+    @property
+    def terminals(self):
+        """Returns terminals list.
+
+        Returns
+        -------
+        List[:class:`Terminal <pyedb.grpc.database.terminal.terminal.Terminal>`]
+        """
+        return [Terminal(self._pedb, terminal) for terminal in self.terminals]

pyedb/grpc/database/terminal/edge_terminal.py

@@ -0,0 +1,51 @@
+# 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.terminal.terminals import BundleTerminal as GrpcBundleTerminal
+from ansys.edb.core.terminal.terminals import EdgeTerminal as GrpcEdgeTerminal
+
+
+class EdgeTerminal(GrpcEdgeTerminal):
+    def __init__(self, pedb, edb_object):
+        super().__init__(edb_object.msg)
+        self._pedb = pedb
+        self._edb_object = edb_object
+
+    def couple_ports(self, port):
+        """Create a bundle wave port.
+
+        Parameters
+        ----------
+        port : :class:`Waveport <pyedb.grpc.database.ports.ports.WavePort>`,
+        :class:`GapPOrt <pyedb.grpc.database.ports.ports.GapPort>`, list, optional
+            Ports to be added.
+
+        Returns
+        -------
+        :class:`BundleWavePort <pyedb.grpc.database.ports.ports.BundleWavePort>`
+        """
+        if not isinstance(port, (list, tuple)):
+            port = [port]
+        temp = [self]
+        temp.extend([i for i in port])
+        bundle_terminal = GrpcBundleTerminal.create(temp)
+        return self._pedb.ports[bundle_terminal.name]

pyedb/grpc/database/terminal/padstack_instance_terminal.py

@@ -0,0 +1,171 @@
+# 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.terminal.terminals import (
+    PadstackInstanceTerminal as GrpcPadstackInstanceTerminal,
+)
+from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
+
+
+class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
+    """Manages bundle terminal properties."""
+
+    def __init__(self, pedb, edb_object=None):
+        if edb_object:
+            super().__init__(edb_object.msg)
+        self._pedb = pedb
+
+    @property
+    def position(self):
+        """Terminal position.
+
+        Returns
+        -------
+        Position [x,y] : [float, float]
+        """
+        pos_x, pos_y, rotation = self.padstack_instance.get_position_and_rotation()
+        return [pos_x.value, pos_y.value]
+
+    @property
+    def location(self):
+        """Terminal position.
+
+        Returns
+        -------
+        Position [x,y] : [float, float]
+        """
+        p_inst, _ = self.params
+        pos_x, pos_y, _ = p_inst.get_position_and_rotation()
+        return [pos_x.value, pos_y.value]
+
+    @property
+    def net_name(self):
+        """Net name.
+
+        Returns
+        -------
+        str : name of the net.
+        """
+        if self.is_null:
+            return ""
+        elif self.net.is_null:
+            return ""
+        else:
+            return self.net.name
+
+    @net_name.setter
+    def net_name(self, val):
+        if not self.is_null and self.net.is_null:
+            self.net.name = val
+
+    @property
+    def magnitude(self):
+        """Source amplitude.
+
+        Returns
+        -------
+        float : amplitude value.
+        """
+        return self.source_amplitude
+
+    @magnitude.setter
+    def magnitude(self, value):
+        self.source_amplitude = value
+
+    @property
+    def phase(self):
+        """Source phase.
+
+        Returns
+        -------
+        float : phase value.
+        """
+        return self.source_phase
+
+    @phase.setter
+    def phase(self, value):
+        self.source_phase = value
+
+    @property
+    def source_amplitude(self):
+        """Source amplitude.
+
+        Returns
+        -------
+        float : amplitude value.
+        """
+        return super().source_amplitude
+
+    @source_amplitude.setter
+    def source_amplitude(self, value):
+        super(PadstackInstanceTerminal, self.__class__).source_amplitude.__set__(self, value)
+
+    @property
+    def source_phase(self):
+        """Source phase.
+
+        Returns
+        -------
+        float : phase value.
+        """
+        return super().source_phase.value
+
+    @source_phase.setter
+    def source_phase(self, value):
+        super(PadstackInstanceTerminal, self.__class__).source_phase.__set__(self, value)
+
+    @property
+    def impedance(self):
+        """Impdeance value.
+
+        Returns
+        -------
+        float : impedance value.
+        """
+        return super().impedance.value
+
+    @impedance.setter
+    def impedance(self, value):
+        super(PadstackInstanceTerminal, self.__class__).impedance.__set__(self, value)
+
+    @property
+    def boundary_type(self):
+        """Boundary type.
+
+        Returns
+        -------
+        str : Boundary type.
+        """
+        return super().boundary_type.name.lower()
+
+    @boundary_type.setter
+    def boundary_type(self, value):
+        mapping = {
+            "port": GrpcBoundaryType.PORT,
+            "dc_terminal": GrpcBoundaryType.DC_TERMINAL,
+            "voltage_probe": GrpcBoundaryType.VOLTAGE_PROBE,
+            "voltage_source": GrpcBoundaryType.VOLTAGE_SOURCE,
+            "current_source": GrpcBoundaryType.CURRENT_SOURCE,
+            "rlc": GrpcBoundaryType.RLC,
+            "pec": GrpcBoundaryType.PEC,
+        }
+        super(PadstackInstanceTerminal, self.__class__).boundary_type.__set__(self, mapping[value.name.lower()])

pyedb/grpc/database/terminal/pingroup_terminal.py

@@ -0,0 +1,162 @@
+# 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.terminal.terminals import BoundaryType as GrpcBoundaryType
+from ansys.edb.core.terminal.terminals import PinGroupTerminal as GrpcPinGroupTerminal
+
+from pyedb.grpc.database.net.net import Net
+
+
+class PinGroupTerminal(GrpcPinGroupTerminal):
+    """Manages pin group terminal properties."""
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(edb_object.msg)
+        self._edb_object = edb_object
+        self._pedb = pedb
+
+    @property
+    def boundary_type(self):
+        """Boundary type.
+
+        Returns
+        -------
+        str : boundary type.
+        """
+        return super().boundary_type.name.lower()
+
+    @boundary_type.setter
+    def boundary_type(self, value):
+        if value == "voltage_source":
+            value = GrpcBoundaryType.VOLTAGE_SOURCE
+        if value == "current_source":
+            value = GrpcBoundaryType.CURRENT_SOURCE
+        if value == "port":
+            value = GrpcBoundaryType.PORT
+        if value == "voltage_probe":
+            value = GrpcBoundaryType.VOLTAGE_PROBE
+        super(PinGroupTerminal, self.__class__).boundary_type.__set__(self, value)
+
+    @property
+    def magnitude(self):
+        """Source magnitude.
+
+        Returns
+        -------
+        float : magnitude value.
+
+        """
+        return self.source_amplitude
+
+    @magnitude.setter
+    def magnitude(self, value):
+        self.source_amplitude = value
+
+    @property
+    def phase(self):
+        """Source phase.
+
+        Returns
+        -------
+        float : phase value.
+
+        """
+        return self.source_phase
+
+    @phase.setter
+    def phase(self, value):
+        self.source_phase = value
+
+    @property
+    def source_amplitude(self):
+        """Source amplitude.
+
+        Returns
+        -------
+        float : source magnitude.
+
+        """
+        return super().source_amplitude
+
+    @source_amplitude.setter
+    def source_amplitude(self, value):
+        super(PinGroupTerminal, self.__class__).source_amplitude.__set__(self, value)
+
+    @property
+    def source_phase(self):
+        """Source phase.
+
+        Returns
+        -------
+        foat : source phase.
+
+        """
+        return super().source_amplitude.value
+
+    @source_phase.setter
+    def source_phase(self, value):
+        super(PinGroupTerminal, self.__class__).source_phase.__set__(self, value)
+
+    @property
+    def impedance(self):
+        """Terminal impedance.
+
+        Returns
+        -------
+        float : terminal impedance.
+
+        """
+        return super().impedance.value
+
+    @impedance.setter
+    def impedance(self, value):
+        super(PinGroupTerminal, self.__class__).impedance.__set__(self, value)
+
+    @property
+    def net(self):
+        """Terminal net.
+
+        Returns
+        -------
+        :class:`Net <pyedb.grpc.database.net.net.Net>`
+            Terminal Net object.
+
+        """
+        return Net(self._pedb, super().net)
+
+    @net.setter
+    def net(self, value):
+        super(PinGroupTerminal, self.__class__).net.__set__(self, value)
+
+    @property
+    def pin_group(self):
+        """Pingroup.
+
+        Returns
+        -------
+        :class:`PinGroup <pyedb.grpc.database.hierarchy.pingroup.PinGroup>`
+            Terminal pingroup.
+
+        """
+        from pyedb.grpc.database.hierarchy.pingroup import PinGroup
+
+        return PinGroup(self._pedb, super().pin_group)

pyedb/grpc/database/terminal/point_terminal.py

@@ -0,0 +1,99 @@
+# 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.geometry.point_data import PointData as GrpcPointData
+from ansys.edb.core.terminal.terminals import PointTerminal as GrpcPointTerminal
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+
+class PointTerminal(GrpcPointTerminal):
+    """Manages point terminal properties."""
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(edb_object.msg)
+        self._pedb = pedb
+
+    @property
+    def location(self):
+        """Terminal position.
+
+        Returns
+        -------
+        [float, float] : [x,y]
+
+        """
+        return [self.point.x.value, self.point.y.value]
+
+    @location.setter
+    def location(self, value):
+        if not isinstance(value, list):
+            return
+        value = [GrpcValue(i) for i in value]
+        self.point = GrpcPointData(value)
+
+    @property
+    def layer(self):
+        """Terminal layer.
+
+        Returns
+        -------
+        :class:`StackupLayer <pyedb.grpc.database.layers.stackup_layer.StackupLayer>`
+
+        """
+        from pyedb.grpc.database.layers.stackup_layer import StackupLayer
+
+        return StackupLayer(self._pedb, super().layer)
+
+    @layer.setter
+    def layer(self, value):
+        if value in self._pedb.stackup.layers:
+            super(PointTerminal, self.__class__).layer.__set__(self, value)
+
+    @property
+    def ref_terminal(self):
+        """Reference terminal.
+
+        Returns
+        -------
+        :class:`PointTerminal <pyedb.grpc.database.terminal.point_terminal.PointTerminal>`
+
+        """
+        return PointTerminal(self._pedb, self.reference_terminal)
+
+    @ref_terminal.setter
+    def ref_terminal(self, value):
+        super().reference_terminal = value
+
+    @property
+    def reference_terminal(self):
+        """Reference terminal.
+
+        Returns
+        -------
+        :class:`PointTerminal <pyedb.grpc.database.terminal.point_terminal.PointTerminal>`
+
+        """
+        return PointTerminal(self._pedb, super().reference_terminal)
+
+    @reference_terminal.setter
+    def reference_terminal(self, value):
+        super(PointTerminal, self.__class__).reference_terminal.__set__(self, value)