Implemented new class ScatteringMethods which is common to Circuit, Hfss and hfss3dlayout classes and contains all the common scattering methods.

refactored expressions so that now is coherent across the different classes and returns a list of names
added expression_objects property which returns the list of the Boundary objects of excitations
added property ports which returns the ports objects (HFSS driven terminal only)

Author: maxcapodi78

_unittest/test_21_Circuit.py

@@ -676,22 +676,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

_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):

_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):

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,

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.

pyaedt/application/AnalysisNexxim.py

@@ -287,7 +287,7 @@ def sources(self):
         return props
 
     @property
-    def excitation_names(self):
+    def excitations(self):
         """List of port names.
 
         Returns
@@ -304,36 +304,24 @@ def excitation_names(self):
         return ports
 
     @property
-    def excitation_objets(self):
+    def excitation_objects(self):
         """List of port objects.
 
         Returns
         -------
-        list
+        dict
             List of port objects.
         """
-        return [self.excitations[name] for name in self.excitations]
-
-    @property
-    def excitations(self):
-        """Get all ports.
-
-        Returns
-        -------
-        list
-            List of ports.
-
-        """
         props = {}
         if not self._internal_excitations:
-            for port in self.excitation_names:
+            for port in self.excitations:
                 props[port] = Excitations(self, port)
             self._internal_excitations = props
         else:
             props = self._internal_excitations
-            if not sorted(list(props.keys())) == sorted(self.excitation_names):
+            if not sorted(list(props.keys())) == sorted(self.excitations):
                 a = set(str(x) for x in props.keys())
-                b = set(str(x) for x in self.excitation_names)
+                b = set(str(x) for x in self.excitations)
                 if len(a) == len(b):
                     unmatched_new_name = list(b - a)[0]
                     unmatched_old_name = list(a - b)[0]
@@ -342,44 +330,15 @@ def excitations(self):
                 else:
                     if len(a) > len(b):
                         for old_port in props.keys():
-                            if old_port not in self.excitation_names:
+                            if old_port not in self.excitations:
                                 del props[old_port]
                                 return props
                     else:
-                        for new_port in self.excitation_names:
+                        for new_port in self.excitations:
                             if new_port not in props.keys():
                                 props[new_port] = Excitations(self, new_port)
         return props
 
-    @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 value is ``[]``, in which case
-            the S parameters for all excitations are to be provided.
-            For example, ``["1", "2"]``.
-
-        Returns
-        -------
-        list of str
-            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 = list(self.excitations.keys())
-        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 get_all_return_loss_list(self, excitation_names=None, excitation_name_prefix=""):
         """Retrieve a list of all return losses for a list of exctitations.
@@ -408,7 +367,7 @@ def get_all_return_loss_list(self, excitation_names=None, excitation_name_prefix
             excitation_names = []
 
         if not excitation_names:
-            excitation_names = list(self.excitations.keys())
+            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 = []
@@ -450,9 +409,9 @@ def get_all_insertion_loss_list(self, trlist=None, reclist=None, tx_prefix="", r
 
         spar = []
         if not trlist:
-            trlist = [i for i in list(self.excitations.keys()) if tx_prefix in i]
+            trlist = [i for i in list(self.excitations) if tx_prefix in i]
         if not reclist:
-            reclist = [i for i in list(self.excitations.keys()) if rx_prefix in i]
+            reclist = [i for i in list(self.excitations) if rx_prefix in i]
         if len(trlist) != len(reclist):
             self.logger.error("The TX and RX lists should be the same length.")
             return False
@@ -485,7 +444,7 @@ def get_next_xtalk_list(self, trlist=[], tx_prefix=""):
         """
         next_xtalks = []
         if not trlist:
-            trlist = [i for i in list(self.excitations.keys()) if tx_prefix in i]
+            trlist = [i for i in list(self.excitations) if tx_prefix in i]
         for i in trlist:
             k = trlist.index(i) + 1
             while k < len(trlist):
@@ -528,9 +487,9 @@ def get_fext_xtalk_list(self, trlist=None, reclist=None, tx_prefix="", rx_prefix
         """
         fext = []
         if trlist is None:
-            trlist = [i for i in list(self.excitations.keys()) if tx_prefix in i]
+            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.keys()) if rx_prefix in i]
+            reclist = [i for i in list(self.excitations) if rx_prefix in i]
         for i in trlist:
             for k in reclist:
                 if not skip_same_index_couples or reclist.index(k) != trlist.index(i):

pyaedt/application/Design.py

@@ -378,12 +378,16 @@ def boundaries(self):
                 self._boundaries[boundary] = NetworkObject(self, boundary)
             else:
                 self._boundaries[boundary] = BoundaryObject(self, boundary, boundarytype=boundarytype)
-
-        excitations = self.design_excitations
-        for exc in excitations:
-            if not self._boundaries or exc.name not in list(self._boundaries.keys()):
-                self._boundaries[exc.name] = exc
-
+        try:
+            if "GetExcitations" in self.oboundary.__dir__():
+                ee = list(self.oboundary.GetExcitations())
+                current_boundaries = [i.split(":")[0] for i in ee[::2]]
+                current_types = ee[1::2]
+                for k, v in zip(current_boundaries, current_types):
+                    if k not in self._boundaries:
+                        self._boundaries[k] = BoundaryObject(self, k, boundarytype=v)
+        except:
+            pass
         return list(self._boundaries.values())
 
     @property
@@ -403,71 +407,30 @@ def boundaries_by_type(self):
         return _dict_out
 
     @property
-    def excitations_by_type(self):
-        """Design excitations by type.
-
-        Returns
-        -------
-        dict
-            Dictionary of excitations.
-        """
-        _dict_out = {}
-        for bound in self.design_excitations:
-            if bound.type in _dict_out:
-                _dict_out[bound.type].append(bound)
-            else:
-                _dict_out[bound.type] = [bound]
-        return _dict_out
-
-    @property
-    def design_excitations(self):
+    def ports(self):
         """Design excitations.
 
         Returns
         -------
         list
-            List of :class:`pyaedt.modules.Boundary.BoundaryObject`.
+            Port names.
         """
-        design_excitations = {}
+        design_excitations = []
 
         if "GetExcitations" in self.oboundary.__dir__():
             ee = list(self.oboundary.GetExcitations())
-            current_boundaries = [i.split(":")[0] for i in ee[::2]]
             current_types = ee[1::2]
             for i in set(current_types):
                 new_port = []
                 if "GetExcitationsOfType" in self.oboundary.__dir__():
                     new_port = list(self.oboundary.GetExcitationsOfType(i))
                 if new_port:
-                    current_boundaries = current_boundaries + new_port
+                    design_excitations += new_port
                     current_types = current_types + [i] * len(new_port)
-
-            for boundary, boundarytype in zip(current_boundaries, current_types):
-                design_excitations[boundary] = BoundaryObject(self, boundary, boundarytype=boundarytype)
-                if (
-                    design_excitations[boundary].object_properties
-                    and design_excitations[boundary].object_properties.props["Type"] == "Terminal"
-                ):  # pragma: no cover
-                    props_terminal = OrderedDict()
-                    props_terminal["TerminalResistance"] = design_excitations[boundary].object_properties.props[
-                        "Terminal Renormalizing Impedance"
-                    ]
-                    props_terminal["ParentBndID"] = design_excitations[boundary].object_properties.props["Port Name"]
-                    design_excitations[boundary] = BoundaryObject(
-                        self, boundary, props=props_terminal, boundarytype="Terminal"
-                    )
+            return design_excitations
 
         elif "GetAllPortsList" in self.oboundary.__dir__() and self.design_type in ["HFSS 3D Layout Design"]:
-            for port in self.oboundary.GetAllPortsList():
-                if port in self._boundaries:
-                    continue
-                bound = self._update_port_info(port)
-                if bound:
-                    design_excitations[port] = bound
-
-        if design_excitations:
-            return list(design_excitations.values())
-
+            return self.oboundary.GetAllPortsList()
         return []
 
     @property