treams.plane_wave

treams.plane_wave(kvec, pol, *, k0=None, basis=None, material=None, modetype=None, poltype=None)

Array describing a plane wave.

Parameters:

• kvec (Sequence) – Wave vector.

• pol (int or Sequence) – Polarization index (see Polarizations) to have a unit amplitude wave of the corresponding wave, two values to specify the amplitude for each polarization, or three values in a sequence to specify the Cartesian electric field components. In the latter case, if the electric field has longitudinal components they are neglected.

• basis (PlaneWaveBasis, optional) – Basis definition.

• k0 (float, optional) – Wave number in vacuum.

• material (Material, optional) – Material definition.

• modetype (str, optional) – Mode type (see Mode types).

• poltype (str, optional) – Polarization type (see Polarizations).