Field projection docstrings improvement #959
Conversation
There was a problem hiding this comment.
Thanks @shashwat-sh . Looks great. Could you also add some general comments about how the users should set the position and size of the projection monitors?
@tomflexcompute I added an additional comment on the size. There is already a mention on the position. I don't think we should be too specific though, at some point the users need to understand the physics of the problem enough to know how to set this up correctly for their application. If we make it too specific, I'm worried users will take our suggestion as a "rule", apply it incorrectly, and then blame the solver. @momchil-flex maybe you can take a look too, to see if these suggestions are general enough in your opinion? |
There was a problem hiding this comment.
Thanks @shashwat-sh . They look good to me. We definitely want to keep them as general as possible but provide some information at the same time.
tidy3d/components/monitor.py
Outdated
| description="Whether to enable the far field approximation when projecting fields. " | ||
| "If ``True``, terms that decay as O(1/r^2) are ignored, as are the radial components " | ||
| "of fields. Typically, this should be set to ``True`` only when the projection distance " | ||
| "is much larger than the size of the device being modeled.", |
There was a problem hiding this comment.
out of curiosity, does the wavelength play into whether far_field_approx is accurate?
There was a problem hiding this comment.
Yeah, in that the observations points should be in the far field of the device - I added a sentence to make this explicit. I didn't specify what number of wavelengths would be considered "far field" because I think that can be application-dependent sometimes.
|
could you run |
shashwat-sh
force-pushed
the
shash/n2f_docs_improvement
branch
from
75eb1a2
to
d37aa84
Compare
shashwat-sh
force-pushed
the
shash/n2f_docs_improvement
branch
from
d37aa84
to
81dd0d3
Compare
shashwat-sh
force-pushed
the
shash/n2f_docs_improvement
branch
from
81dd0d3
to
51ecb9e
Compare
Added more detail to the field projection docstrings based on user feedback. Thanks @tomflexcompute for pointing this out.