Before refactoring smatrix on modeler data

Author: daquinteroflex

tidy3d/plugins/smatrix/component_modelers/base.py

@@ -15,18 +15,13 @@
 from tidy3d.constants import HERTZ
 from tidy3d.exceptions import SetupError, Tidy3dKeyError
 from tidy3d.log import log
-from tidy3d.plugins.smatrix.ports.coaxial_lumped import CoaxialLumpedPort
 from tidy3d.plugins.smatrix.ports.modal import Port
-from tidy3d.plugins.smatrix.ports.rectangular_lumped import LumpedPort
 from tidy3d.plugins.smatrix.ports.wave import WavePort
 
 # fwidth of gaussian pulse in units of central frequency
 FWIDTH_FRAC = 1.0 / 10
 DEFAULT_DATA_DIR = "."
 
-LumpedPortType = Union[LumpedPort, CoaxialLumpedPort]
-TerminalPortType = Union[LumpedPortType, WavePort]
-
 
 class AbstractComponentModeler(ABC, Tidy3dBaseModel):
     """Tool for modeling devices and computing port parameters."""

tidy3d/plugins/smatrix/component_modelers/types.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from typing import Union
+
+from .modal import ComponentModeler
+from .terminal import TerminalComponentModeler
+
+ComponentModelerType = Union[ComponentModeler, TerminalComponentModeler]

tidy3d/plugins/smatrix/data/terminal.py

@@ -16,6 +16,15 @@
 from tidy3d.plugins.smatrix.component_modelers.base import TerminalPortType
 from tidy3d.plugins.smatrix.component_modelers.terminal import TerminalComponentModeler
 from tidy3d.plugins.smatrix.data.data_array import PortDataArray, TerminalPortDataArray
+from tidy3d.plugins.smatrix.utils import (
+    ab_to_s,
+    check_port_impedance_sign,
+    compute_F,
+    compute_port_VI,
+    compute_power_delivered_by_port,
+    compute_power_wave_amplitudes,
+    s_to_z,
+)
 
 
 class MicrowavePortSimulationData(Tidy3dBaseModel):
@@ -78,9 +87,9 @@ class TerminalComponentModelerData(Tidy3dBaseModel):
     @cached_property
     def smatrix(self) -> MicrowaveSMatrixData:
         "Stores the computed S-matrix and reference impedances for the terminal ports"
-        from tidy3d.plugins.smatrix.run.local_run import construct_smatrix
+        from tidy3d.plugins.smatrix.run.terminal import terminal_construct_smatrix
 
-        terminal_port_data = construct_smatrix(simulation=self.simulation)
+        terminal_port_data = terminal_construct_smatrix(simulation=self.simulation)
         smatrix_data = MicrowaveSMatrixData(data=terminal_port_data)
         return smatrix_data
 
@@ -141,7 +150,7 @@ def get_antenna_metrics_data(
             Container with antenna parameters including directivity, gain, and radiation efficiency,
             computed from the superposition of fields from all excited ports.
         """
-        from tidy3d.plugins.smatrix.run.local_run import compute_power_wave_amplitudes_at_each_port
+        from tidy3d.plugins.smatrix.run.terminal import compute_power_wave_amplitudes_at_each_port
 
         # Use the first port as default if none specified
         if port_amplitudes is None:
@@ -210,14 +219,14 @@ def get_antenna_metrics_data(
     @cached_property
     def port_reference_impedances(self) -> PortDataArray:
         """The reference impedance used at each port for definining power wave amplitudes."""
-        from tidy3d.plugins.smatrix.run.local_run import port_reference_impedances
+        from tidy3d.plugins.smatrix.run.terminal import port_reference_impedances
 
         return port_reference_impedances(self.simulation)
 
     def compute_power_wave_amplitudes_at_each_port(
         self, port_reference_impedances: PortDataArray, sim_data: SimulationData
     ) -> tuple[PortDataArray, PortDataArray]:
-        from tidy3d.plugins.smatrix.run.local_run import compute_power_wave_amplitudes_at_each_port
+        from tidy3d.plugins.smatrix.run.terminal import compute_power_wave_amplitudes_at_each_port
 
         data = compute_power_wave_amplitudes_at_each_port(
             simulation=self.simulation,
@@ -228,3 +237,10 @@ def compute_power_wave_amplitudes_at_each_port(
 
     # Mirror Utils
     # So they can be reused elsewhere without a class reimport
+    ab_to_s = ab_to_s
+    compute_F = compute_F
+    check_port_impedance_sign = check_port_impedance_sign
+    compute_port_VI = compute_port_VI
+    compute_power_wave_amplitudes = compute_power_wave_amplitudes
+    compute_power_delivered_by_port = compute_power_delivered_by_port
+    s_to_z = s_to_z

tidy3d/plugins/smatrix/data/types.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from tidy3d.plugins.smatrix.ports.coaxial_lumped import CoaxialLumpedPort
+from tidy3d.plugins.smatrix.ports.rectangular_lumped import LumpedPort
+from tidy3d.plugins.smatrix.ports.wave import WavePort
+
+LumpedPortType = Union[LumpedPort, CoaxialLumpedPort]
+TerminalPortType = Union[LumpedPortType, WavePort]

tidy3d/plugins/smatrix/ports/types.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from ..component_modelers.types import ComponentModelerType
+
+
+def run_batch(
+    modeler: ComponentModelerType, path_dir: str = DEFAULT_DATA_DIR, **kwargs
+) -> BatchData:
+    batch = Batch(simulations=modeler.sim_dict, **kwargs)
+
+    return batch.run(path_dir=path_dir)