renaming and tests

Author: dbochkov-flexcompute

tests/test_components/test_absorbers.py

@@ -133,7 +133,7 @@ def test_port_absorbers_simulations():
             td.InternalAbsorber(
                 size=(0.4, 0.5, 0),
                 direction="-",
-                boundary_spec=td.ModeABCBoundary(plane=td.Box(size=(1, 1, 0)), frequency=freq0),
+                boundary_spec=td.ModeABCBoundary(plane=td.Box(size=(1, 1, 0)), freq_spec=freq0),
             )
         ],
     )
@@ -207,31 +207,31 @@ def test_abc_boundaries_alone():
         plane=td.Box(size=(1, 1, 0)),
         mode_spec=td.ModeSpec(num_modes=2),
         mode_index=1,
-        frequency=freq0,
+        freq_spec=freq0,
     )
 
     with pytest.raises(pydantic.ValidationError):
         _ = td.ModeABCBoundary(
             plane=td.Box(size=(1, 1, 0)),
             mode_spec=td.ModeSpec(num_modes=2),
             mode_index=1,
-            frequency=-1,
+            freq_spec=-1,
         )
 
     with pytest.raises(pydantic.ValidationError):
         _ = td.ModeABCBoundary(
             plane=td.Box(size=(1, 1, 0)),
             mode_spec=td.ModeSpec(num_modes=2),
             mode_index=-1,
-            frequency=freq0,
+            freq_spec=freq0,
         )
 
     with pytest.raises(pydantic.ValidationError):
         _ = td.ModeABCBoundary(
             plane=td.Box(size=(1, 1, 1)),
             mode_spec=td.ModeSpec(num_modes=2),
             mode_index=0,
-            frequency=freq0,
+            freq_spec=freq0,
         )
 
     # from mode source
@@ -250,7 +250,7 @@ def test_abc_boundaries_alone():
         size=(1, 1, 0), mode_spec=td.ModeSpec(num_modes=2), freqs=[freq0], name="mnt"
     )
     mode_abc_from_monitor = td.ModeABCBoundary.from_monitor(
-        mode_monitor, mode_index=1, frequency=freq0
+        mode_monitor, mode_index=1, freq_spec=freq0
     )
     assert mode_abc == mode_abc_from_monitor
 
@@ -263,11 +263,11 @@ def test_abc_boundaries_alone():
         plane=td.Box(size=(1, 1, 0)),
         mode_spec=td.ModeSpec(num_modes=2),
         mode_index=1,
-        frequency=freq0,
+        freq_spec=freq0,
     )
     abc_boundary_from_source = td.Boundary.mode_abc_from_source(mode_source)
     abc_boundary_from_monitor = td.Boundary.mode_abc_from_monitor(
-        mode_monitor, mode_index=1, frequency=freq0
+        mode_monitor, mode_index=1, freq_spec=freq0
     )
     assert abc_boundary == abc_boundary_from_source
     assert abc_boundary == abc_boundary_from_monitor
@@ -430,7 +430,7 @@ def test_abc_boundaries_simulations():
         sources=[],
         run_time=1e-20,
         boundary_spec=td.BoundarySpec.all_sides(
-            td.ModeABCBoundary(plane=td.Box(size=(1, 1, 0)), frequency=freq0)
+            td.ModeABCBoundary(plane=td.Box(size=(1, 1, 0)), freq_spec=freq0)
         ),
     )
     # or at least one source
@@ -533,3 +533,50 @@ def test_abc_boundaries_simulations():
                 td.ABCBoundary(permittivity=2, conductivity=1e-5)
             ),
         )
+
+
+def test_abc_boundaries_broadband():
+    # test broadband fitter params
+    fitter_params = td.BroadbandModeABCFitterParam(
+        max_num_poles=10, tolerance_rms=1e-4, frequency_sampling_points=10
+    )
+
+    # test max num poles > 0
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCFitterParam(max_num_poles=0)
+    # test max num poles <= 10
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCFitterParam(max_num_poles=11)
+
+    # test tolerance rms >= 0
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCFitterParam(tolerance_rms=-1)
+
+    # test frequency sampling points > 0
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCFitterParam(frequency_sampling_points=0)
+    # test frequency sampling points <= 21
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCFitterParam(frequency_sampling_points=22)
+
+    # test basic instance
+    fmin = 100e12
+    fmax = 200e12
+    abc_boundary = td.BroadbandModeABCSpec(frequency_range=(fmin, fmax))
+
+    # test max frequency > min frequency
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCSpec(frequency_range=(fmax, fmin))
+
+    # test min frequency > 0
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.BroadbandModeABCSpec(frequency_range=(0, fmax))
+
+    # test from_wavelength_range
+    wvl_min = td.C_0 / fmax
+    wvl_max = td.C_0 / fmin
+    abc_boundary = td.BroadbandModeABCSpec.from_wavelength_range(
+        wavelength_range=(wvl_min, wvl_max), fit_param=fitter_params
+    )
+    assert abc_boundary.frequency_range == (fmin, fmax)
+    assert abc_boundary.fit_param == fitter_params

tidy3d/__init__.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from tidy3d.components.boundary import BroadbandModeABCSpec
+from tidy3d.components.boundary import BroadbandModeABCFitterParam, BroadbandModeABCSpec
 from tidy3d.components.material.multi_physics import MultiPhysicsMedium
 from tidy3d.components.material.tcad.charge import (
     ChargeConductorMedium,
@@ -429,7 +429,6 @@ def set_logging_level(level: str) -> None:
     "ABCBoundary",
     "Absorber",
     "AbsorberParams",
-    "BroadbandModeABCSpec",
     "AbstractFieldProjectionData",
     "AbstractMedium",
     "AdmittanceNetwork",
@@ -448,6 +447,8 @@ def set_logging_level(level: str) -> None:
     "BoundaryEdgeType",
     "BoundarySpec",
     "Box",
+    "BroadbandModeABCFitterParam",
+    "BroadbandModeABCSpec",
     "CaugheyThomasMobility",
     "CellDataArray",
     "ChargeConductorMedium",