tidy3d icon indicating copy to clipboard operation
tidy3d copied to clipboard

Documentation page about auto shutoff

Open momchil-flex opened this issue 4 years ago • 3 comments

We should explain the implications of fields not decaying sufficiently (FreqMonitors may be wrong) and link the warning that is produced when you load the simulation data to that page for more info.

momchil-flex avatar Feb 04 '22 17:02 momchil-flex

Note: have a property to grab the final decay value for a SimulationData. Also have a warning if the decay value did not get below shutoff when web.loading:

So to close this issue, we just need to edit that warning string?

note also we can remove this comment as part of this

tylerflex avatar Feb 25 '22 18:02 tylerflex

I think what I had in mind about this is to add some explanation in the docs, and link to that explanation in the warning.

Specifically, explain that frequency-domain monitors may be inaccurate if the shutoff value is not reached, since we are doing a time domain simulation, and the equivalent frequency response is only obtained in the limit in which there are no fields before or after the recording time. On the other hand, time monitors are accurate, in case users are looking for a limited time response. We could also explain here that in some cases with long-lived resonances, it is unfeasible to wait for the full field decay. In that case users may want to consider a tool like harminv to analyze the resonances.

momchil-flex avatar Feb 25 '22 18:02 momchil-flex

This would probably be good in FAQ perhaps, then just add the link to it in the warning message I linked above.

tylerflex avatar Feb 25 '22 18:02 tylerflex

Added discussion in the FAQ.

momchil-flex avatar Mar 15 '23 22:03 momchil-flex