ikugh

Author: marc-flex

CHANGELOG.md

@@ -8,9 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
-- Added `HeatChargeSimulation.plot()` method that provides a unified plotting interface. When `property` is `None`, it plots the scene structures using the parent class's plot method. When `property` is specified (e.g., `"heat_conductivity"`, `"electric_conductivity"`, `"source"`), it delegates to `plot_property()`. For CHARGE simulations, electric boundary conditions are automatically added to the plot.
 
 ### Changed
+- For `HeatChargeSimulation` objects, the `plot` function now adds the simulation boundary conditions.
 
 ### Fixed
 

tests/test_components/test_heat_charge.py

@@ -2600,7 +2600,7 @@ def test_heat_only_simulation_with_semiconductor():
 
 
 def test_heat_charge_simulation_plot():
-    """Test the HeatChargeSimulation.plot() method with different property values."""
+    """Test the HeatChargeSimulation.plot() method adds BCs based on simulation type."""
 
     # Create mediums
     solid_medium = td.MultiPhysicsMedium(
@@ -2635,7 +2635,7 @@ def test_heat_charge_simulation_plot():
         name="temp_mnt",
     )
 
-    # Create a heat simulation
+    # Create a HEAT simulation
     heat_sim = td.HeatChargeSimulation(
         medium=fluid_medium,
         structures=[solid_structure],
@@ -2647,33 +2647,25 @@ def test_heat_charge_simulation_plot():
         monitors=[temp_monitor],
     )
 
-    # Test plot with property=None (should use parent's plot)
-    _, ax = plt.subplots()
-    heat_sim.plot(z=0, ax=ax)
-    plt.close()
-
-    # Test that plot(property="heat_conductivity") produces the same result as
-    # plot_property(property="heat_conductivity")
-    _, ax1 = plt.subplots()
-    heat_sim.plot(z=0, property="heat_conductivity", ax=ax1)
-    num_children_plot = len(ax1.get_children())
+    # Test plot for HEAT simulation - should add heat BCs
+    _, ax_scene_only = plt.subplots()
+    heat_sim.scene.plot(z=0, ax=ax_scene_only)
+    num_children_scene_only = len(ax_scene_only.get_children())
     plt.close()
 
-    _, ax2 = plt.subplots()
-    heat_sim.plot_property(z=0, property="heat_conductivity", ax=ax2)
-    num_children_plot_property = len(ax2.get_children())
+    _, ax_with_bc = plt.subplots()
+    heat_sim.plot(z=0, ax=ax_with_bc)
+    num_children_with_bc = len(ax_with_bc.get_children())
     plt.close()
 
-    assert num_children_plot == num_children_plot_property, (
-        "plot(property='heat_conductivity') should produce the same result as "
-        "plot_property(property='heat_conductivity')"
+    # heat_sim.plot() should have more visual elements than scene.plot()
+    # because it adds monitors and heat boundaries for HEAT simulations
+    assert num_children_with_bc - num_children_scene_only >= 2, (
+        "heat_sim.plot() should add at least monitors and heat boundaries "
+        "for HEAT simulations, resulting in at least 2 more visual elements "
+        "than heat_sim.scene.plot()"
     )
 
-    # Test plot with property="source"
-    _, ax = plt.subplots()
-    heat_sim.plot(z=0, property="source", ax=ax)
-    plt.close()
-
     # Now test with a CHARGE simulation
     semicon = td.material_library["cSi"].variants["Si_MultiPhysics"].medium.charge
     Si_n = semicon.updated_copy(N_d=[td.ConstantDoping(concentration=1e16)], name="Si_n")
@@ -2717,13 +2709,7 @@ def test_heat_charge_simulation_plot():
         analysis_spec=td.IsothermalSteadyChargeDCAnalysis(temperature=300),
     )
 
-    # Test plot with property="electric_conductivity"
-    _, ax_elec_prop = plt.subplots()
-    charge_sim.plot(z=0, property="electric_conductivity", ax=ax_elec_prop)
-    plt.close()
-
-    # Verify that electric BCs are added when property=None for CHARGE simulations
-    # by comparing charge_sim.plot() against charge_sim.scene.plot()
+    # Test plot for CHARGE simulation - should add electric BCs
     _, ax_scene_only = plt.subplots()
     charge_sim.scene.plot(z=0, ax=ax_scene_only)
     num_children_scene_only = len(ax_scene_only.get_children())

tidy3d/components/tcad/simulation/heat_charge.py

@@ -1172,9 +1172,9 @@ def plot(
         ax: Ax = None,
         source_alpha: Optional[float] = None,
         monitor_alpha: Optional[float] = None,
-        property: Optional[Literal["heat_conductivity", "electric_conductivity", "source"]] = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
+        fill_structures: bool = True,
     ) -> Ax:
         """Plot each of simulation's components on a plane defined by one nonzero x,y,z coordinate.
 
@@ -1188,44 +1188,24 @@ def plot(
             position of plane in z direction, only one of x, y, z must be specified to define plane.
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
-        alpha : float = None
-            Opacity of the structures being plotted.
-            Defaults to the structure default alpha.
         source_alpha : float = None
             Opacity of the sources. If ``None``, uses Tidy3d default.
         monitor_alpha : float = None
             Opacity of the monitors. If ``None``, uses Tidy3d default.
-        property : Optional[Literal["heat_conductivity", "electric_conductivity", "source"]] = None
-            Specifies the type of simulation for which the plot will be tailored.
-            Options are ["heat_conductivity", "electric_conductivity", "source"]. If ``None``,
-            plots the scene structures and for CHARGE simulations also adds boundary conditions.
         hlim : Tuple[float, float] = None
             The x range if plotting on xy or xz planes, y range if plotting on yz plane.
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
+        fill_structures : bool = True
+            Whether to fill structures with color or just draw outlines.
 
         Returns
         -------
         matplotlib.axes._subplots.Axes
             The supplied or created matplotlib axes.
         """
 
-        # If property is defined, delegate to plot_property
-        if property is not None:
-            return self.plot_property(
-                x=x,
-                y=y,
-                z=z,
-                ax=ax,
-                alpha=alpha,
-                source_alpha=source_alpha,
-                monitor_alpha=monitor_alpha,
-                property=property,
-                hlim=hlim,
-                vlim=vlim,
-            )
-
-        # If property is None, call the parent's plot method
+        # Call the parent's plot method
         ax = super().plot(
             x=x,
             y=y,
@@ -1235,11 +1215,17 @@ def plot(
             monitor_alpha=monitor_alpha,
             hlim=hlim,
             vlim=vlim,
+            fill_structures=fill_structures,
         )
 
-        # For CHARGE simulations, also add electric boundaries
+        # Add boundaries based on simulation type
         simulation_types = self._get_simulation_types()
-        if TCADAnalysisTypes.CHARGE in simulation_types:
+        if TCADAnalysisTypes.HEAT in simulation_types:
+            ax = self.plot_boundaries(ax=ax, x=x, y=y, z=z, property="heat_conductivity")
+        if (
+            TCADAnalysisTypes.CHARGE in simulation_types
+            or TCADAnalysisTypes.CONDUCTION in simulation_types
+        ):
             ax = self.plot_boundaries(ax=ax, x=x, y=y, z=z, property="electric_conductivity")
 
         return ax