output fr change

Author: marc-flex

tests/test_components/test_heat_charge.py

@@ -1566,34 +1566,28 @@ def test_unsteady_parameters():
 
     _ = td.UnsteadyHeatAnalysis(
         initial_temperature=300,
-        unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1, output_fr=2),
+        unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1),
     )
 
     # test non-positive initial temperature raises error
     with pytest.raises(pd.ValidationError):
         _ = td.UnsteadyHeatAnalysis(
             initial_temperature=0,
-            unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1, output_fr=2),
+            unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1),
         )
 
     # test negative time step raises error
     with pytest.raises(pd.ValidationError):
         _ = td.UnsteadyHeatAnalysis(
             initial_temperature=10,
-            unsteady_spec=td.UnsteadySpec(time_step=-0.1, total_time_steps=1, output_fr=2),
+            unsteady_spec=td.UnsteadySpec(time_step=-0.1, total_time_steps=1),
         )
 
     # test negative total time steps raises error
     with pytest.raises(pd.ValidationError):
         _ = td.UnsteadyHeatAnalysis(
             initial_temperature=10,
-            unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=-1, output_fr=2),
-        )
-    # test negative output frequency raises error
-    with pytest.raises(pd.ValidationError):
-        _ = td.UnsteadyHeatAnalysis(
-            initial_temperature=10,
-            unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1, output_fr=-2),
+            unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=-1),
         )
 
 
@@ -1602,11 +1596,15 @@ def test_unsteady_heat_analysis(heat_simulation):
 
     unsteady_analysis_spec = td.UnsteadyHeatAnalysis(
         initial_temperature=300,
-        unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1, output_fr=2),
+        unsteady_spec=td.UnsteadySpec(time_step=0.1, total_time_steps=1),
     )
 
     temp_mnt = td.TemperatureMonitor(
-        center=(0, 0, 0), size=(td.inf, td.inf, td.inf), name="temperature", unstructured=True
+        center=(0, 0, 0),
+        size=(td.inf, td.inf, td.inf),
+        name="temperature",
+        unstructured=True,
+        interval=2,
     )
 
     # this should work since the monitor is unstructured
@@ -1617,3 +1615,7 @@ def test_unsteady_heat_analysis(heat_simulation):
     with pytest.raises(pd.ValidationError):
         temp_mnt = temp_mnt.updated_copy(unstructured=False)
         _ = unsteady_sim.updated_copy(monitors=[temp_mnt])
+
+    with pytest.raises(pd.ValidationError):
+        temp_mnt = temp_mnt.updated_copy(unstructured=True, interval=0)
+        _ = unsteady_sim.updated_copy(monitors=[temp_mnt])

tidy3d/components/tcad/analysis/heat_simulation_type.py

@@ -32,13 +32,6 @@ class UnsteadySpec(Tidy3dBaseModel):
         description="Specifies the total number of time steps run during the simulation.",
     )
 
-    output_fr: pd.PositiveInt = pd.Field(
-        1,
-        title="Output frequency",
-        description="Determines how often output files will be written. I.e., an output "
-        "file will be written every 'output_fr' time steps.",
-    )
-
 
 class UnsteadyHeatAnalysis(Tidy3dBaseModel):
     """

tidy3d/components/tcad/monitors/heat.py

@@ -1,7 +1,18 @@
 """Objects that define how data is recorded from simulation."""
 
+import pydantic.v1 as pd
+
 from tidy3d.components.tcad.monitors.abstract import HeatChargeMonitor
 
 
 class TemperatureMonitor(HeatChargeMonitor):
     """Temperature monitor."""
+
+    interval: pd.PositiveInt = pd.Field(
+        1,
+        title="Interval",
+        description="Sampling rate of the monitor: number of time steps between each measurement. "
+        "Set ``interval`` to 1 for the highest possible resolution in time. "
+        "Higher integer values down-sample the data by measuring every ``interval`` time steps. "
+        "This can be useful for reducing data storage as needed by the application.",
+    )

tidy3d/components/tcad/simulation/heat_charge.py

@@ -1660,7 +1660,6 @@ def _get_simulation_types(self) -> list[TCADAnalysisTypes]:
                 return [TCADAnalysisTypes.CHARGE]
 
         # check if unsteady heat
-        # NOTE: this won't work
         if isinstance(self.analysis_spec, UnsteadyHeatAnalysis):
             return [TCADAnalysisTypes.HEAT]