Skip to content

Commit a6f55f1

Browse files
FilipeFcpmomchil-flex
authored andcommitted
linking FixedAngleSpec notebook to PlaneWave docstring
1 parent b34073d commit a6f55f1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

tidy3d/components/source/field.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,14 @@ class FixedAngleSpec(AbstractAngularSpec):
489489
class PlaneWave(AngledFieldSource, PlanarSource, BroadbandSource):
490490
"""Uniform current distribution on an infinite extent plane. One element of size must be zero.
491491
492+
Notes
493+
-----
494+
495+
For oblique incidence, there are two possible settings: fixed in-plane k-vector and fixed-angle mode.
496+
The first requires Bloch periodic boundary conditions, and the incidence angle is exact only at the central wavelength.
497+
The latter requires periodic boundary conditions and maintains a constant propagation angle over a broadband spectrum.
498+
For more information and important notes, see this example: `Broadband PlaneWave With Constant Oblique Incident Angle <https://docs.simulation.cloud/projects/tidy3d/en/latest/notebooks/BroadbandPlaneWaveWithConstantObliqueIncidentAngle.html>`_.
499+
492500
Example
493501
-------
494502
>>> from tidy3d import GaussianPulse

0 commit comments

Comments
 (0)