do we have backwards compatbility

Author: daquinteroflex

tidy3d/plugins/smatrix/component_modelers/terminal.py

@@ -2,14 +2,17 @@
 
 from __future__ import annotations
 
-import os
 from typing import Optional, Union
 
 import numpy as np
 import pydantic.v1 as pd
 
 from tidy3d.components.base import cached_property
+from tidy3d.components.data.data_array import DataArray, FreqDataArray
+from tidy3d.components.data.monitor_data import MonitorData
+from tidy3d.components.data.sim_data import SimulationData
 from tidy3d.components.geometry.utils_2d import snap_coordinate_to_grid
+from tidy3d.components.microwave.data.monitor_data import AntennaMetricsData
 from tidy3d.components.monitor import DirectivityMonitor
 from tidy3d.components.simulation import Simulation
 from tidy3d.components.source.time import GaussianPulse
@@ -323,32 +326,131 @@ def run(self, path_dir: str = DEFAULT_DATA_DIR):
         from tidy3d.plugins.smatrix.data.data import SMatrixData, TerminalComponentModelerData
 
         _ = self.get_path_dir(path_dir)
-        _ = self._upload_terminal_modeler()
+        # _ = self._upload_terminal_modeler()
         batch_data = self._construct_smatrix()
         smatrix_data = SMatrixData(batch_data=batch_data)
         return TerminalComponentModelerData(simulation=self, data=(smatrix_data,))
 
-    @cached_property
-    def _terminal_modeler_path(self) -> str:
-        """Where we store the  for this :class:`TerminalComponentModeler` instance after the run."""
-        return os.path.join(self.path_dir, "tcp_" + str(hash(self)) + ".hdf5")
-
-    def _upload_terminal_modeler(self):
-        # TODO properly refactor, plugins data types should not have web methods.
-        from tidy3d.web.api.container import Job
-
-        # first try loading the terminal_component_modeler from file, if it exists
-        terminal_modeler_path = self._terminal_modeler_path
-
-        if os.path.exists(terminal_modeler_path):
-            return Job.from_file(fname=terminal_modeler_path)
-
-        return Job(
-            simulation=self,
-            task_name=self.name,
-            folder_name=self.folder_name,
-            callback_url=self.callback_url,
-            verbose=self.verbose,
-            solver_version=self.solver_version,
-            simulation_type="microwave",
+    ##### Backwards compatibility methods #####
+
+    def compute_power_wave_amplitudes_at_each_port(
+        self, port_reference_impedances: PortDataArray, sim_data: SimulationData
+    ) -> tuple[PortDataArray, PortDataArray]:
+        from tidy3d.plugins.smatrix.data.data import SMatrixData, TerminalComponentModelerData
+
+        a = SMatrixData(a=self.batch_data)
+        data = TerminalComponentModelerData(
+            simulation=self, data=a
+        ).compute_power_wave_amplitudes_at_each_port(
+            port_reference_impedances=port_reference_impedances, sim_data=sim_data
+        )
+        return data
+
+    def _monitor_data_at_port_amplitude(
+        self,
+        port: TerminalPortType,
+        sim_data: SimulationData,
+        monitor_data: MonitorData,
+        a_port: Union[FreqDataArray, complex],
+    ) -> MonitorData:
+        from tidy3d.plugins.smatrix.data.data import SMatrixData, TerminalComponentModelerData
+
+        a = SMatrixData(a=self.batch_data)
+        data = TerminalComponentModelerData(
+            simulation=self, data=a
+        )._monitor_data_at_port_amplitude(
+            port=port, sim_data=sim_data, monitor_data=monitor_data, a_port=a_port
         )
+        return data
+
+    def get_antenna_metrics_data(
+        self,
+        port_amplitudes: Optional[dict[str, complex]] = None,
+        monitor_name: Optional[str] = None,
+    ) -> AntennaMetricsData:
+        from tidy3d.plugins.smatrix.data.data import SMatrixData, TerminalComponentModelerData
+
+        a = SMatrixData(a=self.batch_data)
+        data = TerminalComponentModelerData(simulation=self, data=a).get_antenna_metrics_data(
+            port_amplitudes=port_amplitudes, monitor_name=monitor_name
+        )
+        return data
+
+    @staticmethod
+    def _check_port_impedance_sign(Z_numpy: np.ndarray):
+        from tidy3d.plugins.smatrix.utils import _check_port_impedance_sign
+
+        return _check_port_impedance_sign(Z_numpy)
+
+    @cached_property
+    def port_reference_impedances(self) -> PortDataArray:
+        from tidy3d.plugins.smatrix.data.data import SMatrixData, TerminalComponentModelerData
+
+        a = SMatrixData(a=self.batch_data)
+        data = TerminalComponentModelerData(simulation=self, data=a).port_reference_impedances
+        return data
+
+    @staticmethod
+    def s_to_z(
+        s_matrix: TerminalPortDataArray, reference: Union[complex, PortDataArray]
+    ) -> DataArray:
+        from tidy3d.plugins.smatrix.utils import s_to_z
+
+        return s_to_z(s_matrix=s_matrix, reference=reference)
+
+    @staticmethod
+    def ab_to_s(
+        a_matrix: TerminalPortDataArray, b_matrix: TerminalPortDataArray
+    ) -> TerminalPortDataArray:
+        from tidy3d.plugins.smatrix.utils import ab_to_s
+
+        return ab_to_s(a_matrix=a_matrix, b_matrix=b_matrix)
+
+    @staticmethod
+    def compute_power_delivered_by_port(
+        port: Union[LumpedPort, CoaxialLumpedPort], sim_data: SimulationData
+    ) -> FreqDataArray:
+        from tidy3d.plugins.smatrix.utils import compute_power_delivered_by_port
+
+        return compute_power_delivered_by_port(port=port, sim_data=sim_data)
+
+    @staticmethod
+    def compute_power_wave_amplitudes(
+        port: Union[LumpedPort, CoaxialLumpedPort], sim_data: SimulationData
+    ) -> tuple[FreqDataArray, FreqDataArray]:
+        from tidy3d.plugins.smatrix.utils import compute_power_wave_amplitudes
+
+        return compute_power_wave_amplitudes(port=port, sim_data=sim_data)
+
+    @staticmethod
+    def compute_port_VI(
+        port_out: TerminalPortType, sim_data: SimulationData
+    ) -> tuple[FreqDataArray, FreqDataArray]:
+        from tidy3d.plugins.smatrix.utils import compute_port_VI
+
+        return compute_port_VI(port_out=port_out, sim_data=sim_data)
+
+    # @cached_property
+    # def _terminal_modeler_path(self) -> str:
+    #     """Where we store the  for this :class:`TerminalComponentModeler` instance after the run."""
+    #     return os.path.join(self.path_dir, "tcp_" + str(hash(self)) + ".hdf5")
+    #
+    # def _upload_terminal_modeler(self):
+    #     # TODO properly refactor, plugins data types should not have web methods.
+    #     from tidy3d.web.api.container import Job
+    #
+    #     # first try loading the terminal_component_modeler from file, if it exists
+    #     terminal_modeler_path = self._terminal_modeler_path
+    #
+    #     if os.path.exists(terminal_modeler_path):
+    #         return Job.from_file(fname=terminal_modeler_path)
+    #
+    #     return Job(
+    #         simulation=self,
+    #         task_name=self.name,
+    #         folder_name=self.folder_name,
+    #         callback_url=self.callback_url,
+    #         verbose=self.verbose,
+    #         solver_version=self.solver_version,
+    #         simulation_type="microwave",
+    #     )