feat(FXC-4425) Plot BCs in Heat/Charge simulations

[marc-flex]

Greptile Summary

This PR enhances HeatChargeSimulation.plot() to automatically display boundary conditions based on the simulation type. When called, the method now determines whether it's a HEAT, CHARGE, or CONDUCTION simulation and adds the appropriate boundary condition visualizations (heat boundaries for HEAT simulations, electric boundaries for CHARGE/CONDUCTION simulations).

Key changes:

• Overrides plot() method in HeatChargeSimulation to call parent's implementation then add simulation-type-specific boundary conditions
• Delegates to existing plot_boundaries() method with appropriate property parameter
• Added Literal type hint for property parameter in plot_property() method
• Comprehensive test coverage added for both HEAT and CHARGE simulation plotting scenarios

Issues found:

• Missing **patch_kwargs parameter from parent class signature - breaks backward compatibility if users pass additional keyword arguments to plot()
• The **patch_kwargs parameter needs to be forwarded to super().plot() call

Confidence Score: 4/5

• This PR is generally safe to merge with one important fix needed for backward compatibility
• The implementation is clean and well-tested, but the missing **patch_kwargs parameter creates a backward compatibility issue where users passing additional keyword arguments to plot() will encounter errors. This is a logical error that needs to be fixed before merging. The rest of the implementation follows good patterns by delegating to the parent class and reusing existing plot_boundaries() functionality.
• Pay close attention to tidy3d/components/tcad/simulation/heat_charge.py - the plot() method signature must match the parent class to maintain backward compatibility

Important Files Changed

Filename	Overview
CHANGELOG.md	Added changelog entry for new boundary condition plotting feature
tests/test_components/test_heat_charge.py	Added comprehensive test coverage for both HEAT and CHARGE simulation plotting with boundary conditions
tidy3d/components/tcad/simulation/heat_charge.py	Implemented plot() override to automatically add boundary conditions; missing **patch_kwargs parameter from parent signature

Sequence Diagram

sequenceDiagram
    participant User
    participant HeatChargeSimulation
    participant AbstractSimulation
    participant Scene
    participant plot_boundaries

    User->>HeatChargeSimulation: plot(x, y, z, ax, ...)
    HeatChargeSimulation->>AbstractSimulation: super().plot(x, y, z, ax, ...)
    AbstractSimulation->>Scene: scene.plot_structures()
    Scene-->>AbstractSimulation: ax
    AbstractSimulation->>AbstractSimulation: plot_sources()
    AbstractSimulation->>AbstractSimulation: plot_monitors()
    AbstractSimulation->>AbstractSimulation: plot_boundaries()
    AbstractSimulation->>AbstractSimulation: plot_symmetries()
    AbstractSimulation-->>HeatChargeSimulation: ax
    HeatChargeSimulation->>HeatChargeSimulation: _get_simulation_types()
    alt HEAT simulation
        HeatChargeSimulation->>plot_boundaries: plot_boundaries(property="heat_conductivity")
        plot_boundaries-->>HeatChargeSimulation: ax
    end
    alt CHARGE or CONDUCTION simulation
        HeatChargeSimulation->>plot_boundaries: plot_boundaries(property="electric_conductivity")
        plot_boundaries-->>HeatChargeSimulation: ax
    end
    HeatChargeSimulation-->>User: ax

Loading

[Copilot]

Pull request overview

This PR adds a new plot() method to the HeatChargeSimulation class that provides a unified plotting interface. When property is None, it plots scene structures using the parent class's plot method and automatically adds electric boundary conditions for CHARGE simulations. When property is specified, it delegates to the existing plot_property() method.

• Added plot() method with optional property parameter for flexible visualization
• Automatic plotting of electric boundary conditions for CHARGE simulations when property=None
• Updated type annotations for plot_property() method to use Literal types for better type safety

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
tidy3d/components/tcad/simulation/heat_charge.py	Added new plot() method with unified interface, updated type annotations for plot_property() parameter, and added Literal import
tests/test_components/test_heat_charge.py	Added comprehensive test coverage for the new plot() method covering HEAT and CHARGE simulations with various property values
CHANGELOG.md	Documented the new feature in the unreleased section

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[greptile-apps]

Additional Comments (1)

1. tidy3d/components/tcad/simulation/heat_charge.py, line 1284 (link)

   syntax: Docstring type should match type hint more precisely

   Context Used: Rule from dashboard - In docstrings, use the format name : type = default for parameter documentation instead of numpydo... (source)

_{3 files reviewed, 4 comments}

_{Edit Code Review Agent Settings | Greptile}

[marc-flex]

@greptile update summary

[greptile-apps]

_{3 files reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

[github-actions]

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

• tidy3d/components/tcad/simulation/heat_charge.py (100%)

Summary

• Total: 11 lines
• Missing: 0 lines
• Coverage: 100%