FEAT: Toggle net type in Q3D (#6237)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: Samuelopez-ansys

doc/changelog.d/6237.added.md

@@ -0,0 +1 @@
+Toggle net type in q3d

src/ansys/aedt/core/q3d.py

@@ -1399,15 +1399,21 @@ def net_sources(self, net_name):
         >>> net = q3d.net_sources("Net1")
         """
         sources = []
-        net_id = -1
-        for i in self.boundaries:
-            if i.type == "SignalNet" and i.name == net_name and i.props.get("ID", None) is not None:  # pragma: no cover
-                net_id = i.props.get("ID", None)
-                break
-        for i in self.boundaries:
-            if i.type == "Source":
-                if i.props.get("Net", None) == net_name or i.props.get("Net", None) == net_id:
-                    sources.append(i.name)
+
+        # Try to find the matching net from SignalNet boundaries
+        net = next((i for i in self.boundaries_by_type.get("SignalNet", []) if i.name == net_name), None)
+
+        # Get net_id and net_sources_sinks if the net was found
+        net_id = net.props.get("ID") if net and net.props.get("ID") is not None else -1  # pragma: no cover
+        net_sources_sinks = net.children if net else {}
+
+        for boundary in self.boundaries:
+            if boundary.type == "Source" and (
+                boundary.props.get("Net") == net_name
+                or boundary.props.get("Net") == net_id
+                or boundary.name in net_sources_sinks
+            ):
+                sources.append(boundary.name)
 
         return sources
 
@@ -1432,14 +1438,21 @@ def net_sinks(self, net_name):
         >>> net = q3d.net_sinks("Net1")
         """
         sinks = []
-        net_id = -1
-        for i in self.boundaries:
-            if i.type == "SignalNet" and i.name == net_name and i.props.get("ID", None) is not None:
-                net_id = i.props.get("ID", None)  # pragma: no cover
-                break  # pragma: no cover
-        for i in self.boundaries:
-            if i.type == "Sink" and any(map(lambda val: i.props.get("Net", None) == val, [net_name, net_id])):
-                sinks.append(i.name)
+
+        # Try to find the matching net from SignalNet boundaries
+        net = next((i for i in self.boundaries_by_type.get("SignalNet", []) if i.name == net_name), None)
+
+        # Get net_id and net_sources_sinks if the net was found
+        net_id = net.props.get("ID") if net and net.props.get("ID") is not None else -1  # pragma: no cover
+        net_sources_sinks = net.children if net else {}
+
+        for boundary in self.boundaries:
+            if boundary.type == "Sink" and (
+                boundary.props.get("Net") == net_name
+                or boundary.props.get("Net") == net_id
+                or boundary.name in net_sources_sinks
+            ):
+                sinks.append(boundary.name)
         return sinks
 
     @pyaedt_function_handler()
@@ -1479,6 +1492,57 @@ def auto_identify_nets(self):
             self.logger.info("No new nets identified")
         return True
 
+    @pyaedt_function_handler()
+    def toggle_net(self, net_name, net_type="Signal"):
+        """Toggle net type.
+
+        Parameters
+        ----------
+        net_name : str or :class:`ansys.aedt.core.modules.boundary.common.BoundaryObject`, optional
+            Name of the net. The default is ```None``, in which case the
+            default name is used.
+        net_type : str, bool
+            Type of net to create. Options are ``"Signal"``, ``"Ground"`` and ``"Floating"``.
+            The default is ``"Signal"``.
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modules.boundary.common.BoundaryObject`
+            Net object.
+
+        References
+        ----------
+        >>> oModule.ToggleNet
+
+        Examples
+        --------
+        >>> from ansys.aedt.core import Q3d
+        >>> q3d = Q3d()
+        >>> box = q3d.modeler.create_box([30, 30, 30], [10, 10, 10], name="mybox")
+        >>> aedtapp.auto_identify_nets()
+        >>> net = aedtapp.nets[0]
+        >>> new_net = aedtapp.toggle_net(net, "Floating")
+        """
+        if isinstance(net_name, BoundaryObject):
+            net_name = net_name.name
+
+        if net_name not in self.nets:
+            raise ValueError(f"{net_name} is not a valid net name.")
+
+        type_bound = {"ground": "GroundNet", "floating": "FloatingNet"}.get(net_type.lower(), "SignalNet")
+
+        # Delete from list of design excitations
+        if net_name in self._boundaries:
+            self._boundaries.pop(net_name)
+
+        # Toggle
+        self.oboundary.ToggleNet(net_name, type_bound)
+
+        # Update boundaries
+        _ = self.boundaries
+
+        return self._boundaries[net_name]
+
     @pyaedt_function_handler(objects="assignment")
     def assign_net(self, assignment, net_name=None, net_type="Signal"):
         """Assign a net to a list of objects.
@@ -1517,11 +1581,8 @@ def assign_net(self, assignment, net_name=None, net_type="Signal"):
         if not net_name:
             net_name = generate_unique_name("Net")
         props = dict({"Objects": assignment})
-        type_bound = "SignalNet"
-        if net_type.lower() == "ground":
-            type_bound = "GroundNet"
-        elif net_type.lower() == "floating":
-            type_bound = "FloatingNet"
+
+        type_bound = {"ground": "GroundNet", "floating": "FloatingNet"}.get(net_type.lower(), "SignalNet")
 
         return self._create_boundary(net_name, props, type_bound)
 

tests/system/solvers/test_31_Q3D.py

@@ -178,8 +178,30 @@ def test_06c_auto_identify(self, aedtapp):
         aedtapp.modeler.create_box([20, 5, 0], [1, 1, 20], material="brass")
 
         assert aedtapp.auto_identify_nets()
+        assert len(aedtapp.nets) == 2
         assert aedtapp.delete_all_nets()
+        assert len(aedtapp.nets) == 0
         assert aedtapp.auto_identify_nets()
+        nets = aedtapp.nets
+
+        net1 = aedtapp.design_excitations[nets[0]]
+        net2 = aedtapp.design_excitations[nets[1]]
+
+        new_net1 = aedtapp.toggle_net(net1, "Floating")
+        assert new_net1.type == "FloatingNet"
+        net1_1 = aedtapp.design_excitations[nets[0]]
+        assert net1_1.type == "FloatingNet"
+        net1_2 = aedtapp.excitation_objects[nets[0]]
+        assert net1_2.type == "FloatingNet"
+        assert "FloatingNet" in list(aedtapp.boundaries_by_type.keys())
+
+        new_net2 = aedtapp.toggle_net(net2.name, "Ground")
+        assert new_net2.type == "GroundNet"
+        net2_1 = aedtapp.design_excitations[nets[1]]
+        assert net2_1.type == "GroundNet"
+        net2_2 = aedtapp.excitation_objects[nets[1]]
+        assert net2_2.type == "GroundNet"
+        assert "GroundNet" in list(aedtapp.boundaries_by_type.keys())
 
     def test_07_create_source_sinks(self, aedtapp):
         udp = aedtapp.modeler.Position(0, 0, 0)
@@ -565,3 +587,33 @@ def test_21_mutual_coupling(self, coupling):
 
         assert not coupling.get_mutual_coupling("ac2", "a1", "a3", "a1")
         assert not coupling.get_mutual_coupling("a1", "a2", "b2", "b1", calculation="ACL2")
+
+    def test_toggle_net_with_sources(self, add_app):
+        app = add_app(application=Q3d, design_name="toggle_net")
+        udp = app.modeler.Position(0, 0, 0)
+        coax_dimension = 30
+        app.modeler.create_cylinder(app.PLANE.XY, udp, 3, coax_dimension, 0, name="MyCylinder", material="brass")
+
+        _ = app.source("MyCylinder", direction=0, name="Source1")
+        _ = app.sink("MyCylinder", direction=3, name="Sink1")
+        app.auto_identify_nets()
+        net = app.nets[0]
+        assert len(app.excitation_objects) == 3
+        assert "SignalNet" in app.excitations_by_type
+        sources = app.net_sources(net)
+        sinks = app.net_sinks(net)
+
+        with pytest.raises(ValueError):
+            app.toggle_net(net_name="invented")
+
+        new_net = app.toggle_net(net, "Ground")
+        assert new_net.type == "GroundNet"
+        assert len(app.excitation_objects) == 1
+        assert len(app.boundaries) == 1
+        new_sources = app.net_sources(net)
+        new_sinks = app.net_sinks(net)
+
+        assert len(sources) != len(new_sources)
+        assert len(sinks) != len(new_sinks)
+        assert "GroundNet" in app.excitations_by_type
+        assert "SignalNet" not in app.excitations_by_type