Introduced axial ratio to DirectivityMonitor #1860

QimingFlex · 2024-07-29T15:15:39Z

Introduced field axial_ratio in the DirectivityMonitor.

@dmarek-flex suggested renaming the DirectivityMonitor class to RadiationMonitor as radiation is more general and can include many characteristics such as directivity, gain, axial ratio, etc. I think this is reasonable and better. What do you think, @weiliangjin2021? Do you have other suggestions?

weiliangjin2021 · 2024-07-29T21:22:55Z

Introduced field axial_ratio in the DirectivityMonitor.

@dmarek-flex suggested renaming the DirectivityMonitor class to RadiationMonitor as radiation is more general and can include many characteristics such as directivity, gain, axial ratio, etc. I think this is reasonable and better. What do you think, @weiliangjin2021? Do you have other suggestions?

I don't think we can rename it now, as it's released already in v2.7.0. But you can add a new monitor called RadiationMonitor, and add a warning in DirectivityMonitor that it'll be deprecated in v3.0.

QimingFlex · 2024-07-29T21:41:19Z

Introduced field axial_ratio in the DirectivityMonitor.
@dmarek-flex suggested renaming the DirectivityMonitor class to RadiationMonitor as radiation is more general and can include many characteristics such as directivity, gain, axial ratio, etc. I think this is reasonable and better. What do you think, @weiliangjin2021? Do you have other suggestions?

I don't think we can rename it now, as it's released already in v2.7.0. But you can add a new monitor called RadiationMonitor, and add a warning in DirectivityMonitor that it'll be deprecated in v3.0.

Yeah, sounds good.

dmarek-flex · 2024-07-30T13:22:10Z

CHANGELOG.md

 - Introduce RF material library. Users can now export `rf_material_library` from `tidy3d.plugins.microwave`.
+- Users can now export `SimulationData` to MATLAB `.mat` files with the `to_mat_file` method.
+- Introduce RF material library. Users can now import `rf_material_library` from `tidy3d.plugins.microwave`.


Duplicate RF material bullet points and possible mistake adding the MATLAB one?

I changed "import" from "export" in line 14 and messed this up. I will revert these changes.

dmarek-flex · 2024-07-30T13:40:35Z

tidy3d/components/data/monitor_data.py

+        ..., title="Axial ratio", description="Axial ratio with an angle-based projection grid."
+    )


I believe our convention is to capitalize each word in the title

dmarek-flex · 2024-07-30T13:55:29Z

tidy3d/components/data/monitor_data.py

@@ -1989,16 +1990,17 @@ class DirectivityData(MonitorData):

    Example
    -------
-    >>> from tidy3d import DirectivityDataArray
+    >>> from tidy3d import DirectivityDataArray, AxialRatioDataArray
    >>> f = np.linspace(1e14, 2e14, 10)
    >>> r = np.atleast_1d(5)


This is pedantic, but the radiation characteristics should be independent of r, since radiation intensity is scaled by r^2. Including r is not required, maybe if we rename later we can remove r, unless I am missing something.

Actually this projection distance r is used to compute the propagation factor to get the correct Etheta and Ephi.

That's right, but it ultimately isn't necessary for describing the resulting Directivity. Directivity only depends on frequency and angular position, the same as radiation intensity.

That makes sense.

I just found that if we give up introducing the coordinate "r" here, we will need to do a corresponding coordinate change in the backend, which will make the code ugly. As this class inherits from FieldProjectionAngleMonitor, which has the coordinate "r", it's better to keep it consistent I guess? Users typically don't need to specify this value and can use the default value of 1e6.

Looks fine to keep it if the default value works fine in most simulations.

Yea, totally fine to keep it. I just wanted to point out that we don't absolutely need it in these DataArrays.

dmarek-flex

Thanks @QimingFlex, it looks pretty clear to me! I just found a couple of things to nitpick.

weiliangjin2021

All look nice!

weiliangjin2021 · 2024-07-30T18:35:26Z

Actually one comment: could you add the definition and the reference for the axial ratio? As you mentioned in the solver, the definition is not unique, so it will be good to clarify which definition is used.

QimingFlex · 2024-07-30T20:19:20Z

Actually one comment: could you add the definition and the reference for the axial ratio? As you mentioned in the solver, the definition is not unique, so it will be good to clarify which definition is used.

Yeah, I updated the reference to Balanis's equations (2-65) to (2-67). The backend computations are equivalent to these equations. Balanis uses absolute values and phase differences between two components for the computations. Instead, we compute using complex numbers directly. This has also been mentioned in the backend computations.

weiliangjin2021 · 2024-07-30T20:26:30Z

Actually one comment: could you add the definition and the reference for the axial ratio? As you mentioned in the solver, the definition is not unique, so it will be good to clarify which definition is used.

Yeah, I updated the reference to Balanis's equations (2-65) to (2-67). The backend computations are equivalent to these equations. Balanis uses absolute values and phase differences between two components for the computations. Instead, we compute using complex numbers directly. This has also been mentioned in the backend computations.

Great! One minor format: the doc can read better if formatted in this way.

Also I wonder if the reference should also be cited in the DirectivityMonitor docstring, as users might not even read the docstring of AxialRatioDataArray

QimingFlex · 2024-07-30T20:56:55Z

Actually one comment: could you add the definition and the reference for the axial ratio? As you mentioned in the solver, the definition is not unique, so it will be good to clarify which definition is used.

Yeah, I updated the reference to Balanis's equations (2-65) to (2-67). The backend computations are equivalent to these equations. Balanis uses absolute values and phase differences between two components for the computations. Instead, we compute using complex numbers directly. This has also been mentioned in the backend computations.

Great! One minor format: the doc can read better if formatted in this way.

Also I wonder if the reference should also be cited in the DirectivityMonitor docstring, as users might not even read the docstring of AxialRatioDataArray

Yeah, both have been updated, also updated drectivity reference in the DirectivityMonitor.

tylerflex

just one changelog comment.

tylerflex · 2024-08-01T17:36:13Z

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `WavePort` to the `TerminalComponentModeler` which is the suggested port type for exciting transmission lines.
 - Added plotting functionality to voltage and current path integrals in the `microwave` plugin.
 - Added convenience functions `from_terminal_positions` and `from_circular_path` to simplify setup of `VoltageIntegralAxisAligned` and `CustomCurrentIntegral2D`, respectively.
+- Added axial ratio computation to `DirectivityMonitor`


please mention how to grab this information, for example DirectivityMonitor.axial_ratio. Also what is the axial ratio? consider adding , defined as the ratio of the major axis to the minor axis of the polarization ellipse.

Adding this info into the changelog reduces the barrier of entry for people who just catch sight of the new feature to start using it.

otherwise PR looks good!

also, maybe the more technically correct thing here is to say that it is added to the "DirectivityData.axial_ratio corresponding to a DirectivityMonitor".?

Rivised, thanks @tylerflex !

QimingFlex changed the base branch from develop to pre/2.8 July 29, 2024 15:16

QimingFlex force-pushed the qiming/axial_ratio branch 2 times, most recently from 0c66615 to f1aef0b Compare July 29, 2024 21:13

QimingFlex marked this pull request as ready for review July 29, 2024 21:13

QimingFlex requested review from weiliangjin2021 and dmarek-flex July 29, 2024 21:14

QimingFlex changed the title ~~Introduced axial ratio data array to DirectivityMonitor~~ Introduced axial ratio to DirectivityMonitor Jul 29, 2024

dmarek-flex reviewed Jul 30, 2024

View reviewed changes

dmarek-flex approved these changes Jul 30, 2024

View reviewed changes

weiliangjin2021 approved these changes Jul 30, 2024

View reviewed changes

QimingFlex force-pushed the qiming/axial_ratio branch 2 times, most recently from cfe3bc9 to c394ceb Compare July 30, 2024 20:10

QimingFlex force-pushed the qiming/axial_ratio branch from c394ceb to 28a5192 Compare July 30, 2024 20:55

QimingFlex requested a review from tylerflex July 31, 2024 21:18

tylerflex approved these changes Aug 1, 2024

View reviewed changes

QimingFlex force-pushed the qiming/axial_ratio branch 2 times, most recently from bd487fa to f8a5069 Compare August 1, 2024 20:35

Introduced axial_ratio to DirectivityMonitor

4042c5f

QimingFlex force-pushed the qiming/axial_ratio branch from f8a5069 to 4042c5f Compare August 1, 2024 20:43

QimingFlex merged commit 8d7b5bb into pre/2.8 Aug 5, 2024
16 checks passed

QimingFlex deleted the qiming/axial_ratio branch August 5, 2024 15:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduced axial ratio to DirectivityMonitor #1860

Introduced axial ratio to DirectivityMonitor #1860

QimingFlex commented Jul 29, 2024 •

edited

Loading

weiliangjin2021 commented Jul 29, 2024

QimingFlex commented Jul 29, 2024

dmarek-flex Jul 30, 2024 •

edited

Loading

QimingFlex Jul 30, 2024

dmarek-flex Jul 30, 2024

dmarek-flex Jul 30, 2024

QimingFlex Jul 30, 2024

dmarek-flex Jul 30, 2024

QimingFlex Jul 30, 2024

QimingFlex Jul 30, 2024

weiliangjin2021 Jul 30, 2024

dmarek-flex Jul 30, 2024

dmarek-flex left a comment

weiliangjin2021 left a comment

weiliangjin2021 commented Jul 30, 2024

QimingFlex commented Jul 30, 2024

weiliangjin2021 commented Jul 30, 2024

QimingFlex commented Jul 30, 2024

tylerflex left a comment

tylerflex Aug 1, 2024

tylerflex Aug 1, 2024

QimingFlex Aug 1, 2024

		..., title="Axial ratio", description="Axial ratio with an angle-based projection grid."
		)

Introduced axial ratio to DirectivityMonitor #1860

Introduced axial ratio to DirectivityMonitor #1860

Conversation

QimingFlex commented Jul 29, 2024 • edited Loading

weiliangjin2021 commented Jul 29, 2024

QimingFlex commented Jul 29, 2024

dmarek-flex Jul 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmarek-flex left a comment

Choose a reason for hiding this comment

weiliangjin2021 left a comment

Choose a reason for hiding this comment

weiliangjin2021 commented Jul 30, 2024

QimingFlex commented Jul 30, 2024

weiliangjin2021 commented Jul 30, 2024

QimingFlex commented Jul 30, 2024

tylerflex left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

QimingFlex commented Jul 29, 2024 •

edited

Loading

dmarek-flex Jul 30, 2024 •

edited

Loading