Merge branch 'main' into ci/refact_cicd

Author: SMoraisAnsys

Diff for: _unittest/test_01_Design.py

@@ -38,8 +38,17 @@ def test_app(self):
         assert self.aedtapp
 
     def test_01_designname(self):
-        self.aedtapp.design_name = "myname"
-        assert self.aedtapp.design_name == "myname"
+        # TODO: Remove subsequent dependence on string "myname"
+        design_names = ["myname", "design2"]
+        self.aedtapp.design_name = design_names[0]  # Change the design name.
+        assert self.aedtapp.design_name == design_names[0]
+        self.aedtapp.insert_design(design_names[1])  # Insert a new design
+        assert self.aedtapp.design_name == design_names[1]
+        self.aedtapp.design_name = design_names[0]  # Change current design back.
+        assert len(self.aedtapp.design_list) == 2  # Make sure there are still 2 designs.
+        assert self.aedtapp.design_list[0] == design_names[0]  # Make sure the name is correct.
+        self.aedtapp.delete_design(design_names[1])  # Delete the 2nd design
+        assert len(self.aedtapp.design_list) == 1
 
     def test_01_version_id(self):
         assert self.aedtapp.aedt_version_id

Diff for: _unittest/test_21_Circuit.py

@@ -677,22 +677,21 @@ def test_41_assign_excitations(self, add_app):
         port.reference_node = "NoNet"
         port.reference_node = "Z"
 
-        assert c.excitation_objets
+        assert c.excitation_objects
 
         setup = c.create_setup()
 
-        c.excitations["Port3"].enabled_sources = ["PowerTest"]
-        assert len(c.excitations["Port3"].enabled_sources) == 1
+        c.excitation_objects["Port3"].enabled_sources = ["PowerTest"]
+        assert len(c.excitation_objects["Port3"].enabled_sources) == 1
         setup1 = c.create_setup()
         setup2 = c.create_setup()
-        c.excitations["Port3"].enabled_analyses = {"PowerTest": [setup.name, setup2.name]}
-        assert c.excitations["Port3"].enabled_analyses["PowerTest"][0] == setup.name
+        c.excitation_objects["Port3"].enabled_analyses = {"PowerTest": [setup.name, setup2.name]}
+        assert c.excitation_objects["Port3"].enabled_analyses["PowerTest"][0] == setup.name
 
-        c.excitations["Port3"].name = "PortTest"
+        c.excitation_objects["Port3"].name = "PortTest"
         assert "PortTest" in c.excitations
-        assert "PortTest" in c.excitation_names
-        c.excitations["PortTest"].delete()
-        assert len(c.excitation_objets) == 0
+        c.excitation_objects["PortTest"].delete()
+        assert len(c.excitation_objects) == 0
         self.aedtapp.save_project()
         c = add_app(application=Circuit, design_name="sources")
         assert c.sources

Diff for: _unittest/test_22_Circuit_DynamicLink.py

@@ -176,9 +176,9 @@ def test_07_create_page_port_and_interface_port(self):
             "Port_remove",
             [hfss3Dlayout_pin2location["J3B2.2.USBH2_DN_CH"][0], hfss3Dlayout_pin2location["J3B2.2.USBH2_DN_CH"][1]],
         )
-        self.aedtapp.excitations[portname.name].delete()
+        self.aedtapp.excitation_objects[portname.name].delete()
 
-        assert "Port_remove" not in self.aedtapp.excitation_names
+        assert "Port_remove" not in self.aedtapp.excitations
 
     @pytest.mark.skipif(is_ironpython or is_linux, reason="Skipped because Desktop is crashing")
     def test_08_assign_excitations(self):

Diff for: _unittest/test_27_Maxwell2D.py

@@ -545,14 +545,16 @@ def test_35_solution_types_setup(self, add_app):
     def test_36_design_excitations_by_type(self):
         coils = self.aedtapp.excitations_by_type["Coil"]
         assert coils
-        assert len(coils) == len([bound for bound in self.aedtapp.design_excitations if bound.type == "Coil"])
+        assert len(coils) == len([bound for bound in self.aedtapp.excitation_objects.values() if bound.type == "Coil"])
         currents = self.aedtapp.excitations_by_type["Current"]
         assert currents
-        assert len(currents) == len([bound for bound in self.aedtapp.design_excitations if bound.type == "Current"])
+        assert len(currents) == len(
+            [bound for bound in self.aedtapp.excitation_objects.values() if bound.type == "Current"]
+        )
         wdg_group = self.aedtapp.excitations_by_type["Winding Group"]
         assert wdg_group
         assert len(wdg_group) == len(
-            [bound for bound in self.aedtapp.design_excitations if bound.type == "Winding Group"]
+            [bound for bound in self.aedtapp.excitation_objects.values() if bound.type == "Winding Group"]
         )
 
     def test_37_boundaries_by_type(self):

Diff for: pyaedt/application/Analysis.py

@@ -122,6 +122,7 @@ def __init__(
             port,
             aedt_process_id,
         )
+        self._excitation_objects = {}
         self._setup = None
         if setup_name:
             self.active_setup = setup_name
@@ -477,6 +478,46 @@ def excitations(self):
         except Exception:
             return []
 
+    @property
+    def excitations_by_type(self):
+        """Design excitations by type.
+
+        Returns
+        -------
+        dict
+            Dictionary of excitations.
+        """
+        _dict_out = {}
+        for bound in self.excitation_objects.values():
+            if bound.type in _dict_out:
+                _dict_out[bound.type].append(bound)
+            else:
+                _dict_out[bound.type] = [bound]
+        return _dict_out
+
+    @property
+    def excitation_objects(self):
+        """Get all excitation.
+
+        Returns
+        -------
+        dict
+            List of excitation boundaries. Excitations with multiple modes will return one
+            excitation for each mode.
+
+        References
+        ----------
+
+        >>> oModule.GetExcitations
+        """
+        exc_names = self.excitations[::]
+
+        for el in self.boundaries:
+            if el.name in exc_names:
+                self._excitation_objects[el.name] = el
+
+        return self._excitation_objects
+
     @pyaedt_function_handler()
     def get_traces_for_plot(
         self,

Diff for: pyaedt/application/Analysis3DLayout.py

@@ -158,35 +158,6 @@ def excitations(self):
         """
         return list(self.oboundary.GetAllPortsList())
 
-    @property
-    def get_all_sparameter_list(self, excitation_names=[]):
-        """List of all S parameters for a list of excitations.
-
-        Parameters
-        ----------
-        excitation_names : list, optional
-            List of excitations. The default is ``[]``, in which case
-            the S parameters for all excitations are to be provided.
-            For example, ``["1", "2"]``.
-
-        Returns
-        -------
-        list
-            List of strings representing the S parameters of the excitations.
-            For example, ``["S(1, 1)", "S(1, 2)", S(2, 2)]``.
-
-        """
-        if not excitation_names:
-            excitation_names = self.excitations
-        spar = []
-        k = 0
-        for i in excitation_names:
-            k = excitation_names.index(i)
-            while k < len(excitation_names):
-                spar.append("S({},{})".format(i, excitation_names[k]))
-                k += 1
-        return spar
-
     @pyaedt_function_handler()
     def change_design_settings(self, settings):
         """Set HFSS 3D Layout Design Settings.
@@ -235,224 +206,6 @@ def export_mesh_stats(self, setup_name, variation_string="", mesh_path=None):
         self.odesign.ExportMeshStats(setup_name, variation_string, mesh_path)
         return mesh_path
 
-    @pyaedt_function_handler()
-    def get_all_return_loss_list(
-        self, excitation_names=None, excitation_name_prefix="", math_formula="", net_list=None
-    ):
-        """Get a list of all return losses for a list of excitations.
-
-        Parameters
-        ----------
-        excitation_names : list, optional
-            List of excitations. The default is ``None``, in which case
-            the return losses for all excitations are provided.
-            For example ``["1", "2"]``.
-        excitation_name_prefix : string, optional
-             Prefix to add to the excitation names. The default is ``""``,
-        math_formula : str, optional
-            One of the available AEDT mathematical formulas to apply. For example, ``abs, dB``.
-        net_list : list, optional
-            List of nets to filter the output. The default is ``None``, in which case all parameters are returned.
-
-        Returns
-        -------
-        list of str
-            List of strings representing the return losses of the excitations.
-            For example, ``["S(1, 1)", S(2, 2)]``.
-
-        References
-        ----------
-
-        >>> oEditor.GetAllPorts
-        """
-        if excitation_names == None:
-            excitation_names = []
-
-        if not excitation_names:
-            excitation_names = list(self.excitations)
-        if excitation_name_prefix:
-            excitation_names = [i for i in excitation_names if excitation_name_prefix.lower() in i.lower()]
-        spar = []
-        for i in excitation_names:
-            if not net_list or (net_list and [net for net in net_list if net in i]):
-                if math_formula:
-                    spar.append("{}(S({},{}))".format(math_formula, i, i))
-                else:
-                    spar.append("S({},{})".format(i, i))
-        return spar
-
-    @pyaedt_function_handler()
-    def get_all_insertion_loss_list(
-        self, trlist=None, reclist=None, tx_prefix="", rx_prefix="", math_formula="", net_list=None
-    ):
-        """Get a list of all insertion losses from two lists of excitations (driver and receiver).
-
-        Parameters
-        ----------
-        trlist : list, optional
-            List of drivers. The default is ``[]``. For example, ``["1"]``.
-        reclist : list, optional
-            List of receivers. The default is ``[]``. The number of drivers equals
-            the number of receivers. For example, ``["2"]``.
-        tx_prefix : str, optional
-            Prefix to add to driver names. For example, ``"DIE"``. The default is ``""``.
-        rx_prefix : str, optional
-            Prefix to add to receiver names. For example, ``"BGA"``. The default is ``""``.
-        math_formula : str, optional
-            One of the available AEDT mathematical formulas to apply. For example, ``abs, dB``.
-        net_list : list, optional
-            List of nets to filter the output. The default is ``None``, in which
-            case all parameters are returned.
-
-        Returns
-        -------
-        list of str
-            List of strings representing insertion losses of the excitations.
-            For example, ``["S(1,2)"]``.
-
-        References
-        ----------
-
-        >>> oEditor.GetAllPorts
-        """
-        if trlist is None:
-            trlist = [i for i in list(self.excitations)]
-
-        if reclist is None:
-            reclist = [i for i in list(self.excitations)]
-        if tx_prefix:
-            trlist = [i for i in trlist if i.startswith(tx_prefix)]
-        if rx_prefix:
-            reclist = [i for i in reclist if i.startswith(rx_prefix)]
-        spar = []
-        if not net_list and len(trlist) != len(reclist):
-            self.logger.error("The TX and RX lists should be the same length.")
-            return False
-        if net_list:
-            for el in net_list:
-                x = [i for i in trlist if el in i]
-                y = [i for i in reclist if el in i]
-                for x1 in x:
-                    for y1 in y:
-                        if x1[-2:] == y1[-2:]:
-                            if math_formula:
-                                spar.append("{}(S({},{}))".format(math_formula, x1, y1))
-                            else:
-                                spar.append("S({},{})".format(x1, y1))
-                            break
-        else:
-            for i, j in zip(trlist, reclist):
-                if math_formula:
-                    spar.append("{}(S({},{}))".format(math_formula, i, j))
-                else:
-                    spar.append("S({},{})".format(i, j))
-        return spar
-
-    @pyaedt_function_handler()
-    def get_next_xtalk_list(self, trlist=None, tx_prefix="", math_formula="", net_list=None):
-        """Get a list of all the near end XTalks from a list of excitations (driver and receiver).
-
-        Parameters
-        ----------
-        trlist : list, optional
-            List of drivers. The default is ``None``. For example,
-            ``["1", "2", "3"]``.
-        tx_prefix : str, optional
-            Prefix to add to driver names. For example, ``"DIE"``.  The default is ``""``.
-        math_formula : str, optional
-            One of the available AEDT mathematical formulas to apply. For example, ``abs, dB``.
-        net_list : list, optional
-            List of nets to filter the output. The default is ``None``, in which case
-            all parameters are returned.
-
-        Returns
-        -------
-        list of str
-            List of strings representing near end XTalks of the excitations.
-            For example, ``["S(1, 2)", "S(1, 3)", "S(2, 3)"]``.
-
-        References
-        ----------
-
-        >>> oEditor.GetAllPorts
-        """
-        next_xtalks = []
-        if not trlist:
-            trlist = [i for i in list(self.excitations) if tx_prefix in i]
-        for i in trlist:
-            if not net_list or (net_list and [net for net in net_list if net in i]):
-                k = trlist.index(i) + 1
-                while k < len(trlist):
-                    if math_formula:
-                        next_xtalks.append("{}(S({},{}))".format(math_formula, i, trlist[k]))
-                    else:
-                        next_xtalks.append("S({},{})".format(i, trlist[k]))
-                    k += 1
-        return next_xtalks
-
-    @pyaedt_function_handler()
-    def get_fext_xtalk_list(
-        self,
-        trlist=None,
-        reclist=None,
-        tx_prefix="",
-        rx_prefix="",
-        skip_same_index_couples=True,
-        math_formula="",
-        net_list=None,
-    ):
-        """Geta list of all the far end XTalks from two lists of excitations (driver and receiver).
-
-        Parameters
-        ----------
-        trlist : list, optional
-            List of drivers. The default is ``[]``. For example,
-            ``["1", "2"]``.
-        reclist : list, optional
-            List of receiver. The default is ``[]``. For example,
-            ``["3", "4"]``.
-        tx_prefix : str, optional
-            Prefix for driver names. For example, ``"DIE"``.  The default is ``""``.
-        rx_prefix : str, optional
-            Prefix for receiver names. For examples, ``"BGA"`` The default is ``""``.
-        skip_same_index_couples : bool, optional
-            Whether to skip driver and receiver couples with the same index position.
-            The default is ``True``, in which case the drivers and receivers
-            with the same index position are considered insertion losses and
-            excluded from the list.
-        math_formula : str, optional
-            One of the available AEDT mathematical formulas to apply. For example, ``abs, dB``.
-        net_list : list, optional
-            List of nets to filter the output. The default is ``None``, in which case all
-            parameters are returned.
-
-        Returns
-        -------
-        list of str
-            List of strings representing the far end XTalks of the excitations.
-            For example, ``["S(1, 4)", "S(2, 3)"]``.
-
-        References
-        ----------
-
-        >>> oEditor.GetAllPorts
-        """
-
-        fext = []
-        if trlist is None:
-            trlist = [i for i in list(self.excitations) if tx_prefix in i]
-        if reclist is None:
-            reclist = [i for i in list(self.excitations) if rx_prefix in i]
-        for i in trlist:
-            if not net_list or (net_list and [net for net in net_list if net in i]):
-                for k in reclist:
-                    if not skip_same_index_couples or reclist.index(k) != trlist.index(i):
-                        if math_formula:
-                            fext.append("{}(S({},{}))".format(math_formula, i, k))
-                        else:
-                            fext.append("S({},{})".format(i, k))
-        return fext
-
     @property
     def modeler(self):
         """Modeler object.