refactor mode spec to inheritance

refactor impedance results into MicrowaveModeData and associated classes

refactor monitors in progress

finishing monitor/data refactor

fix changelog

improve coverage

changelog and migration guide update

Author: dmarek-flex

CHANGELOG.md

@@ -10,9 +10,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Added support for `tidy3d-extras`, an optional plugin that enables more accurate local mode solving via subpixel averaging.
+- Added `MicrowaveModeSpec` for RF-specific mode information with customizable characteristic impedance calculations through `ImpedanceSpec`.
+- Added `MicrowaveModeMonitor` and `MicrowaveModeSolverMonitor` for microwave and RF mode analysis with transmission line data.
+- Added `MicrowaveModeData` and `MicrowaveModeSolverData` extending mode solver results with characteristic impedance, voltage coefficients, and current coefficients.
+- Added `AutoImpedanceSpec` for automatic transmission line impedance calculation based on simulation geometry.
+- Added `CustomImpedanceSpec` for user-defined voltage and current path specifications in impedance calculations.
+- Added voltage integral specification classes: `AxisAlignedVoltageIntegralSpec` and `Custom2DVoltageIntegralSpec`.
+- Added current integral specification classes: `AxisAlignedCurrentIntegralSpec`, `CompositeCurrentIntegralSpec`, and `Custom2DCurrentIntegralSpec`.
 
 ### Changed
 - Improved performance of antenna metrics calculation by utilizing cached wave amplitude calculations instead of recomputing wave amplitudes for each port excitation in the `TerminalComponentModelerData`.
+- All RF and microwave specific components now inherit from `MicrowaveBaseModel`.
+- **[BREAKING]** Renamed path integral classes in `tidy3d.plugins.microwave` for improved consistency. Please see our migration guide for details on updating your code.
+  - `VoltageIntegralAxisAligned` → `AxisAlignedVoltageIntegral`
+  - `CurrentIntegralAxisAligned` → `AxisAlignedCurrentIntegral`
+  - `CustomPathIntegral2D` → `Custom2DPathIntegral`
+  - `CustomVoltageIntegral2D` → `Custom2DVoltageIntegral`
+  - `CustomCurrentIntegral2D` → `Custom2DCurrentIntegral`
 
 ### Fixed
 - More robust `Sellmeier` and `Debye` material model, and prevent very large pole parameters in `PoleResidue` material model.
@@ -28,14 +42,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - A new type of doping box has been introduced, `CustomDoping` which accepts a `SpatialDataArray` to define doping concentration. Unlike in the case where a `SpatialDataArray`, custom doping defined with `CustomDoping` have additive behavior, i.e., one can add other doping on top. This deprecates the `SpatialDataArray` as direct input for `N_a` and `N_d`.
 - Non-isothermal Charge simulations are now available. One can now run this type of simulations by using the `SteadyChargeDCAnalysis` as the `analysis_spec` of a `HeatChargeSimulation`. This type of simulations couple the heat equation with the drift-diffusion equations which allow to account for self heating behavior.
 - Because non-isothermal Charge simulations are now supported, new models for the effective density of states and bandgap energy have been introduced. These models are the following: `ConstantEffectiveDOS`, `IsotropicEffectiveDOS`, `MultiValleyEffectiveDOS`, `DualValleyEffectiveDOS`.
-- Added `MicrowaveModeSpec` for RF-specific mode information with customizable characteristic impedance calculations through `ImpedanceSpec`.
 
 ### Changed
 - `LayerRefinementSpec` defaults to assuming structures made of different materials are interior-disjoint for more efficient mesh generation.
 - Removal of the Adjoint plugin.
 - Deprecation of Python 3.9 support.
--  Removal of the Adjoint plugin.
--  All RF and microwave specific components now inherit from `MicrowaveBaseModel`.
 
 ### Fixed
 - Stricter validation for `bend_radius` in mode simulations, preventing the bend center from coinciding with the simulation boundary.

docs/api/microwave/index.rst

@@ -8,6 +8,12 @@ Overview
 
    RF simulations will be subject to new license requirements in the future.
 
+.. warning::
+
+   Breaking changes were introduced in ``v2.10.0``, please see the migration guide for help migrating your code.
+
+   + `Migration Guide <microwave_migration.html>`_
+
 This page consolidates Tidy3D features related to microwave and RF simulation. While microwave/RF and optical simulations have many properties in common, there are some differences in the typical RF user workflow that deserve special consideration.
 
 The following sections discuss:

docs/api/microwave/microwave_migration.rst

@@ -0,0 +1,130 @@
+.. _microwave_migration:
+
+v2.10 Refactor Migration
+-------------------------
+
+In version ``v2.10.0``, microwave plugin path integral classes were renamed for improved consistency and clarity. This guide helps you update your scripts to use the new class names.
+
+Key Changes
+~~~~~~~~~~~
+
+*   **Renamed Classes**: Path integral classes have been renamed to follow a consistent naming pattern.
+*   **Exports**: All renamed classes are exported from ``tidy3d.plugins.microwave`` - no import path changes needed.
+
+Class Name Changes
+~~~~~~~~~~~~~~~~~~
+
+The following classes have been renamed for consistency:
+
+**Voltage Integrals:**
+
+*   ``VoltageIntegralAxisAligned`` → ``AxisAlignedVoltageIntegral``
+*   ``CustomVoltageIntegral2D`` → ``Custom2DVoltageIntegral``
+
+**Current Integrals:**
+
+*   ``CurrentIntegralAxisAligned`` → ``AxisAlignedCurrentIntegral``
+*   ``CustomCurrentIntegral2D`` → ``Custom2DCurrentIntegral``
+
+**Path Integrals:**
+
+*   ``CustomPathIntegral2D`` → ``Custom2DPathIntegral``
+
+Migration Examples
+~~~~~~~~~~~~~~~~~~
+
+**Before (v2.9.x):**
+
+.. code-block:: python
+
+    from tidy3d.plugins.microwave import (
+        VoltageIntegralAxisAligned,
+        CurrentIntegralAxisAligned,
+    )
+
+    voltage_path = VoltageIntegralAxisAligned(
+        center=(0, 0, 0),
+        size=(0, 0, 1),
+        sign="+",
+    )
+
+    current_path = CurrentIntegralAxisAligned(
+        center=(0, 0, 0),
+        size=(2, 1, 0),
+        sign="+",
+    )
+
+**After (v2.10+):**
+
+.. code-block:: python
+
+    from tidy3d.plugins.microwave import (
+        AxisAlignedVoltageIntegral,
+        AxisAlignedCurrentIntegral,
+    )
+
+    voltage_path = AxisAlignedVoltageIntegral(
+        center=(0, 0, 0),
+        size=(0, 0, 1),
+        sign="+",
+    )
+
+    current_path = AxisAlignedCurrentIntegral(
+        center=(0, 0, 0),
+        size=(2, 1, 0),
+        sign="+",
+    )
+
+Custom 2D Path Integrals
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Before:**
+
+.. code-block:: python
+
+    from tidy3d.plugins.microwave import (
+        CustomVoltageIntegral2D,
+        CustomCurrentIntegral2D,
+    )
+
+    vertices = [[0, 0], [1, 0], [1, 1], [0, 1]]
+
+    voltage_path = CustomVoltageIntegral2D(
+        axis=2,
+        position=0.0,
+        vertices=vertices,
+    )
+
+    current_path = CustomCurrentIntegral2D(
+        axis=2,
+        position=0.0,
+        vertices=vertices,
+    )
+
+**After:**
+
+.. code-block:: python
+
+    from tidy3d.plugins.microwave import (
+        Custom2DVoltageIntegral,
+        Custom2DCurrentIntegral,
+    )
+
+    vertices = [[0, 0], [1, 0], [1, 1], [0, 1]]
+
+    voltage_path = Custom2DVoltageIntegral(
+        axis=2,
+        position=0.0,
+        vertices=vertices,
+    )
+
+    current_path = Custom2DCurrentIntegral(
+        axis=2,
+        position=0.0,
+        vertices=vertices,
+    )
+
+Summary
+~~~~~~~
+
+All functionality remains the same - only class names have changed. Simply update your imports and class names according to the table above, and your code will work with v2.10.