add WavePorts #1741

dmarek-flex · 2024-06-05T16:00:07Z

add a new type of port to the TerminalComponentModeler. WavePorts are the optimal port for exciting transmission lines, and they function like a hybrid between LumpedPorts and the modal-based Port.

Still a work in progress.

Here are some thoughts:

Not sure the best way to make the computed port impedances available to users. Computing the port impedances requires mode solving which is launched through ModeSolverMonitors along with the tidy3d simulations. However, some users might want to know the impedances beforehand or inspect modes before launching the simulations.
I have changed some of the naming to reflect that the ports of the TerminalComponentModeler are based on pairs of terminals ( a positive and negative connection or node in the circuit). LumpedPorts and WavePort are then both TerminalPorts
I realized it is helpful to add names and possibly attrs to DataArrays that I am creating. Maybe I should put all of these DataArrays into the microwave plugin or the Tidy3D files.

dmarek-flex · 2024-06-13T21:06:30Z

@weiliangjin2021 @QimingFlex Still a bit rough at the moment in terms of docstrings and other details. But if you want to take a look over the next week while I am validating the accuracy, I am ready for feedback.

weiliangjin2021

1st pass through the code. I'll definitely need to take several more rounds to have a better understanding. Very cool to see all components stick together! One main question is if we should support multiple ways of computing impedance: using any two quantities of V, I, P.

tidy3d/plugins/microwave/impedance_calculator.py

tidy3d/plugins/smatrix/ports/coaxial_lumped.py

dmarek-flex · 2024-06-18T18:52:35Z

One main question is if we should support multiple ways of computing impedance: using any two quantities of V, I, P.

Yeah, it is all hidden away in the ImpedanceCalculator. User can provide any definition of voltage they want (by defining the associated voltage path integral). Same goes for current computation. If both integrals are provided, the impedance is computed as expected V/I. If only one is provided, the ImpedanceCalculator will revert to using the total flux the indirectly compute the other quantity. If none are provided, a ValidationError gets raised.

dmarek-flex · 2024-06-18T20:08:19Z

1st pass through the code. I'll definitely need to take several more rounds to have a better understanding. Very cool to see all components stick together! One main question is if we should support multiple ways of computing impedance: using any two quantities of V, I, P.

Might help for your review to check out this notebook.

weiliangjin2021

Went through another pass. All look quite nice to me! I'm still wondering if we have a way to compute currents that doesn't need contour path integration. One way that I can think of is as follows (but don't know if it works well):

On the modal plane (let's assume it to be xy-plane), compute J at every grid point through J = Curl H. Next we integrate Jz over the entire modal plane. During the integration, we integrate only positive or negatie Jz, as otherwise the current cancels out. So it's int dS Heaviside(J_Z) J_z. Does it agree with the contour path approach for TEM mode?

Some minor comments:

It'll be very helpful to also visualize voltage/current integration path in the plot.
For voltage integration path, in many cases, it is an straight line. When it's axis-aligned, it'll be more convenient to allow the definition through 2 endpoints?

tidy3d/plugins/smatrix/ports/wave.py

dmarek-flex · 2024-06-25T13:18:22Z

On the modal plane (let's assume it to be xy-plane), compute J at every grid point through J = Curl H. Next we integrate Jz over the entire modal plane. During the integration, we integrate only positive or negatie Jz, as otherwise the current cancels out. So it's int dS Heaviside(J_Z) J_z. Does it agree with the contour path approach for TEM mode?

That could work, and it seems like a discrete version of Stoke's theorem, so should be equivalent. It is also probably an easier way to implement the computation on the Yee grid when the conductors are complicated shapes. I don't think that I could use that method for computing currents at the ports though, because we do not know whether the current is flowing into or out of the port before computing. Could be used for compute Z0 when we can assume the propagation direction.

However, since it seems possible to apply this to more complex shapes more easily, I think I will try. We could still make the user define a path around the conductor of interest. Instead of computing the line integral though, we compute the current inside the contour using curl H.

It'll be very helpful to also visualize voltage/current integration path in the plot.

Yes, good idea! I'll experiment.

For voltage integration path, in many cases, it is an straight line. When it's axis-aligned, it'll be more convenient to allow the definition through 2 endpoints?

So do you mean an option to create path integrals given P1(x1,y1,z1) and P2(x2,y2,z2) and just ensure that that it is axis aligned with a validator? If so I can do that!

weiliangjin2021 · 2024-06-25T18:48:09Z

So do you mean an option to create path integrals given P1(x1,y1,z1) and P2(x2,y2,z2) and just ensure that that it is axis aligned with a validator? If so I can do that!

Hopefully we can also support axis-unaligned straight path. But you mentioned there is complication for that

dmarek-flex · 2024-06-25T19:31:36Z

So do you mean an option to create path integrals given P1(x1,y1,z1) and P2(x2,y2,z2) and just ensure that that it is axis aligned with a validator? If so I can do that!

Hopefully we can also support axis-unaligned straight path. But you mentioned there is complication for that

Agreed, at least we can easily swap out implementations for voltage and current integrals easily. But that is an improvement that is needed.

tylerflex

thanks @dmarek-flex . Looks overall good to me. Although I can't follow many of the specific details.

tidy3d/plugins/microwave/custom_path_integrals.py

tidy3d/plugins/microwave/path_integrals.py

tidy3d/plugins/microwave/impedance_calculator.py

tidy3d/plugins/smatrix/component_modelers/base.py

dmarek-flex · 2024-07-04T19:40:08Z

It'll be very helpful to also visualize voltage/current integration path in the plot.

Just adding some tests, but path integrals can be plotted now.

weiliangjin2021 · 2024-07-05T16:48:30Z

It'll be very helpful to also visualize voltage/current integration path in the plot.

Just adding some tests, but path integrals can be plotted now.

Nice figure!

dmarek-flex · 2024-07-05T17:18:11Z

tidy3d/components/viz.py

@@ -73,18 +73,15 @@ def _plot(*args, **kwargs) -> Ax:
 """ plot parameters """


-class PlotParams(Tidy3dBaseModel):
-    """Stores plotting parameters / specifications for a given model."""
+class AbstractPlotParams(Tidy3dBaseModel):


@tylerflex Might want to check my changes here which I used for plotting the path integrals

dmarek-flex · 2024-07-05T17:18:53Z

tidy3d/components/geometry/base.py

@@ -684,6 +684,29 @@ def parse_xyz_kwargs(**xyz) -> Tuple[Axis, float]:
        axis = "xyz".index(axis_label)
        return axis, position

+    @staticmethod
+    def parse_two_xyz_kwargs(**xyz) -> List[Tuple[Axis, float]]:


@tylerflex also here which might affect others

tidy3d/plugins/microwave/path_integrals.py

added path integral plotting functionality added convenience function for defining voltage path integral from end points

dmarek-flex · 2024-07-26T18:00:11Z

@weiliangjin2021 I am ready to merge this as soon as you confirm. Tests are passing after rebase and my testing notebook is giving good results. I just changed the CHANGELOG to reflect the changes in this PR.

weiliangjin2021

Please go ahead

dmarek-flex self-assigned this Jun 5, 2024

dmarek-flex added the 2.8 will go into version 2.8.* label Jun 5, 2024

dmarek-flex marked this pull request as draft June 5, 2024 16:05

dmarek-flex force-pushed the dmarek/wave_ports branch from 8cfd8b6 to 4760d74 Compare June 12, 2024 15:48

dmarek-flex changed the base branch from pre/2.7 to develop June 12, 2024 16:48

dmarek-flex requested review from weiliangjin2021 and QimingFlex June 13, 2024 21:05

weiliangjin2021 reviewed Jun 18, 2024

View reviewed changes

tidy3d/plugins/microwave/impedance_calculator.py Outdated Show resolved Hide resolved

tidy3d/plugins/smatrix/ports/coaxial_lumped.py Outdated Show resolved Hide resolved

dmarek-flex force-pushed the dmarek/wave_ports branch from 612f551 to c49602c Compare June 18, 2024 19:52

dmarek-flex marked this pull request as ready for review June 18, 2024 20:07

weiliangjin2021 reviewed Jun 21, 2024

View reviewed changes

tidy3d/plugins/smatrix/ports/wave.py Show resolved Hide resolved

tidy3d/plugins/smatrix/ports/wave.py Outdated Show resolved Hide resolved

dmarek-flex changed the base branch from develop to pre/2.8 June 27, 2024 14:48

tylerflex approved these changes Jun 28, 2024

View reviewed changes

dmarek-flex force-pushed the dmarek/wave_ports branch from 5239d79 to 287892f Compare July 4, 2024 19:37

dmarek-flex force-pushed the dmarek/wave_ports branch 2 times, most recently from cc4fb27 to f6c0c40 Compare July 5, 2024 16:17

dmarek-flex commented Jul 5, 2024

View reviewed changes

tidy3d/plugins/microwave/path_integrals.py Show resolved Hide resolved

dmarek-flex force-pushed the dmarek/wave_ports branch from f6c0c40 to e2915f8 Compare July 25, 2024 20:35

add wave ports

949c712

added path integral plotting functionality added convenience function for defining voltage path integral from end points

dmarek-flex force-pushed the dmarek/wave_ports branch from e2915f8 to 949c712 Compare July 25, 2024 20:42

weiliangjin2021 approved these changes Jul 26, 2024

View reviewed changes

dmarek-flex merged commit f321980 into pre/2.8 Jul 26, 2024
16 checks passed

dmarek-flex deleted the dmarek/wave_ports branch July 26, 2024 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add WavePorts #1741

add WavePorts #1741

dmarek-flex commented Jun 5, 2024 •

edited

Loading

dmarek-flex commented Jun 13, 2024

weiliangjin2021 left a comment

dmarek-flex commented Jun 18, 2024

dmarek-flex commented Jun 18, 2024

weiliangjin2021 left a comment •

edited

Loading

dmarek-flex commented Jun 25, 2024 •

edited

Loading

weiliangjin2021 commented Jun 25, 2024

dmarek-flex commented Jun 25, 2024

tylerflex left a comment

dmarek-flex commented Jul 4, 2024 •

edited

Loading

weiliangjin2021 commented Jul 5, 2024

dmarek-flex Jul 5, 2024

dmarek-flex Jul 5, 2024

dmarek-flex commented Jul 26, 2024

weiliangjin2021 left a comment

add WavePorts #1741

add WavePorts #1741

Conversation

dmarek-flex commented Jun 5, 2024 • edited Loading

dmarek-flex commented Jun 13, 2024

weiliangjin2021 left a comment

Choose a reason for hiding this comment

dmarek-flex commented Jun 18, 2024

dmarek-flex commented Jun 18, 2024

weiliangjin2021 left a comment • edited Loading

Choose a reason for hiding this comment

dmarek-flex commented Jun 25, 2024 • edited Loading

weiliangjin2021 commented Jun 25, 2024

dmarek-flex commented Jun 25, 2024

tylerflex left a comment

Choose a reason for hiding this comment

dmarek-flex commented Jul 4, 2024 • edited Loading

weiliangjin2021 commented Jul 5, 2024

dmarek-flex Jul 5, 2024

Choose a reason for hiding this comment

dmarek-flex Jul 5, 2024

Choose a reason for hiding this comment

dmarek-flex commented Jul 26, 2024

weiliangjin2021 left a comment

Choose a reason for hiding this comment

dmarek-flex commented Jun 5, 2024 •

edited

Loading

weiliangjin2021 left a comment •

edited

Loading

dmarek-flex commented Jun 25, 2024 •

edited

Loading

dmarek-flex commented Jul 4, 2024 •

edited

Loading