Skip to content

Commit d20549e

Browse files
shashwat-shmomchil-flex
authored andcommitted
fixed docstrings for n2f monitors
1 parent da90b0c commit d20549e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

tidy3d/components/monitor.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ def storage_size(self, num_cells: int, tmesh: int) -> int:
478478

479479

480480
class AbstractNear2FarMonitor(SurfaceIntegrationMonitor, FreqMonitor):
481-
""":class:`Monitor` class that samples electromagnetic near fields in the frequency domain
481+
""":class:`Monitor` that samples electromagnetic near fields in the frequency domain
482482
and invokes the computation of far fields.
483483
"""
484484

@@ -525,7 +525,7 @@ def local_origin(self) -> Coordinate:
525525

526526
class Near2FarAngleMonitor(AbstractNear2FarMonitor):
527527
""":class:`Monitor` that samples electromagnetic near fields in the frequency domain
528-
and invokes the computation of far fields at given observation angles.
528+
and invokes the computation of far fields at given observation angles.
529529
530530
Example
531531
-------
@@ -563,7 +563,9 @@ def storage_size(self, num_cells: int, tmesh: ArrayLike[float, 1]) -> int:
563563

564564
class Near2FarCartesianMonitor(AbstractNear2FarMonitor):
565565
""":class:`Monitor` that samples electromagnetic near fields in the frequency domain
566-
and invokes the computation of far fields on a Cartesian observation plane.
566+
and invokes the computation of far fields on a Cartesian observation plane.
567+
The far-field approximation is used, so results projected to points close to
568+
the monitor's position, compared to its size, may not be accurate.
567569
568570
Example
569571
-------
@@ -622,7 +624,7 @@ def storage_size(self, num_cells: int, tmesh: ArrayLike[float, 1]) -> int:
622624

623625
class Near2FarKSpaceMonitor(AbstractNear2FarMonitor):
624626
""":class:`Monitor` that samples electromagnetic near fields in the frequency domain
625-
and invokes the computation of far fields on an observation plane defined in k-space.
627+
and invokes the computation of far fields on an observation plane defined in k-space.
626628
627629
Example
628630
-------

0 commit comments

Comments
 (0)