fdtdx.WaveCharacter

Bases: TreeClass

Class describing a wavelength/period/frequency in free space. Importantly, the wave characteristic conversion is based on a free space wave when using the wavelength (For conversion, a refractive index of 1 is used).

Attributes:
  • phase_shift (float) –

    Phase shift in radians. Defaults to 0.

  • period (float | None) –

    Optional period in seconds. Mutually exclusive with wavelength and frequency. Defaults to None.

  • wavelength (float | None) –

    Optional wavelength in meters for free space propagation. Mutually exclusive with period and frequency. Defaults to None.

  • frequency (float | None) –

    Optional frequency in Hz. Mutually exclusive with period and wavelength.