remove incorrect validation of power waves

Author: dmarek-flex

tests/test_plugins/smatrix/test_terminal_component_modeler.py

@@ -1163,58 +1163,6 @@ def test_run_only_and_element_mappings(monkeypatch, tmp_path):
     assert len(modeler_with_mappings.sim_dict) == 2
 
 
-def test_validate_s_param_def():
-    """Test that the s_param_def field is validated correctly, especially when it is set to 'power'."""
-    # Create a base modeler using the existing convenience function
-    modeler = make_component_modeler(planar_pec=True)
-
-    port0_idx = modeler.network_index(modeler.ports[0])
-    port1_idx = modeler.network_index(modeler.ports[1])
-    S11 = (port0_idx, port0_idx)
-    S21 = (port1_idx, port0_idx)
-    S12 = (port0_idx, port1_idx)
-    S22 = (port1_idx, port1_idx)
-    element_mappings = ((S11, S22, 1),)
-
-    # s_param_def="pseudo" is the most flexible choice when running a subset of simulations
-    modeler_pseudo = (
-        modeler.updated_copy(
-            s_param_def="pseudo",
-            assume_ideal_excitation=True,
-            run_only=(modeler.ports[0].name,),
-        ),
-    )
-
-    # s_param_def="power" with assume_ideal_excitation=True should fail
-    with pytest.raises(pd.ValidationError):
-        modeler.updated_copy(
-            s_param_def="power",
-            assume_ideal_excitation=True,
-        )
-
-    # s_param_def="power" with run_only not None should fail
-    with pytest.raises(pd.ValidationError):
-        modeler.updated_copy(
-            s_param_def="power",
-            run_only=(modeler.ports[0].name,),
-        )
-
-    # s_param_def="power" with element_mappings not empty should fail
-    with pytest.raises(pd.ValidationError):
-        modeler.updated_copy(
-            s_param_def="power",
-            element_mappings=element_mappings,
-        )
-
-    # s_param_def="power" with all valid settings should pass
-    modeler_power_valid = modeler.updated_copy(
-        s_param_def="power",
-        assume_ideal_excitation=False,
-        run_only=None,
-        element_mappings=(),
-    )
-
-
 def test_internal_construct_smatrix_with_port_vi(monkeypatch):
     """Test _internal_construct_smatrix method by monkeypatching compute_port_VI
     with precomputed voltage and current values and comparing the final S-matrix to expected results.

tidy3d/plugins/smatrix/component_modelers/terminal.py

@@ -92,45 +92,6 @@ def _warn_rf_license(cls, values):
         )
         return values
 
-    @pd.validator("s_param_def", always=True)
-    def _validate_s_param_def(cls, s_param_def, values):
-        """
-        Check that the scattering parameter computation is set up correctly for the power wave definition.
-        """
-
-        if s_param_def == "pseudo":
-            return s_param_def
-
-        assume_ideal_excitation = values.get("assume_ideal_excitation")
-        if assume_ideal_excitation is True:
-            raise SetupError(
-                "Setting `assume_ideal_excitation` to ``True`` is incompatible with "
-                "using the power wave definition of scattering parameters. "
-                "Either use the pseudo wave definition by setting 's_param_def' to 'pseudo', "
-                "or set 'assume_ideal_excitation' to ``False``. "
-            )
-
-        run_only = values.get("run_only")
-        if run_only is not None:
-            raise SetupError(
-                "Computing scattering parameters using the power wave definition "
-                "requires running a number of simulations equal to the number of ports. "
-                "Either use the pseudo wave definition by setting 's_param_def' to 'pseudo', "
-                "or ensure all simulations are run by setting 'run_only' to 'None'. "
-            )
-
-        element_mappings = values.get("element_mappings")
-        if len(element_mappings) != 0:
-            raise SetupError(
-                "Computing scattering parameters using the power wave definition "
-                "requires running a number of simulations equal to the number of ports. "
-                "Either use the pseudo wave definition by setting 's_param_def' to 'pseudo', "
-                "or ensure all simulations are run by keeping 'element_mappings' as its "
-                "default value of an empty 'tuple'. "
-            )
-
-        return s_param_def
-
     @equal_aspect
     @add_ax_if_none
     def plot_sim(
@@ -835,7 +796,7 @@ def get_antenna_metrics_data(
     ) -> AntennaMetricsData:
         """Calculate antenna parameters using superposition of fields from multiple port excitations.
 
-        The method computes the radiated far fields and port excitation wave amplitudes
+        The method computes the radiated far fields and port excitation power wave amplitudes
         for a superposition of port excitations, which can be used to analyze antenna radiation
         characteristics.
 
@@ -845,6 +806,8 @@ def get_antenna_metrics_data(
             Dictionary mapping port names to their desired excitation amplitudes. For each port,
             :math:`\\frac{1}{2}|a|^2` represents the incident power from that port into the system.
             If None, uses only the first port without any scaling of the raw simulation data.
+            Note that in this method ``a`` represents the incident wave amplitude
+            using the power wave definition in [2].
         monitor_name : str = None
             Name of the :class:`.DirectivityMonitor` to use for calculating far fields.
             If None, uses the first monitor in `radiation_monitors`.
@@ -871,7 +834,7 @@ def get_antenna_metrics_data(
         else:
             rad_mon = self.get_radiation_monitor_by_name(monitor_name)
 
-        # Create data arrays for holding the superposition of all port wave amplitudes
+        # Create data arrays for holding the superposition of all port power wave amplitudes
         f = list(rad_mon.freqs)
         coords = {"f": f, "port": list(self.matrix_indices_monitor)}
         a_sum = PortDataArray(
@@ -885,7 +848,7 @@ def get_antenna_metrics_data(
             radiation_data = sim_data_port[rad_mon.name]
 
             a, b = self.compute_wave_amplitudes_at_each_port(
-                self.port_reference_impedances, sim_data_port, s_param_def="pseudo"
+                self.port_reference_impedances, sim_data_port, s_param_def="power"
             )
             # Select a possible subset of frequencies
             a = a.sel(f=f)
@@ -904,7 +867,7 @@ def get_antenna_metrics_data(
             a = scale_factor * a
             b = scale_factor * b
 
-            # Combine the possibly scaled directivity data and the wave amplitudes
+            # Combine the possibly scaled directivity data and the power wave amplitudes
             if combined_directivity_data is None:
                 combined_directivity_data = scaled_directivity_data
             else: