acdecom.WaveGuide.get_psi

WaveGuide.get_psi(m, n, pos1, pos2, **kwargs)

Placeholder for the normalized mode shapes of the (m,n)-mode. When the object is initialized, this function may be overwritten either by one of the predefined normalization functions WaveGuide.get_psi_circular() (circular waveguide) and WaveGuide.get_psi_rect() (rectangular waveguide), or a custom function.

Parameters

  • m (int or array_like) – Mode-order in the first direction. If the waveguide is circular, m indicates the circumferential mode-order. The plane wave has the order 0.

  • n (int or array_like) – Mode-order in the second direction. If the waveguide is circular, n indicates the radial mode-order. The plane wave has the order 0.

  • pos1 (float or array_like) – Position in the first direction.

  • pos2 (float or array_like) – Position in the second direction.

  • kwargs (additional arguments) –

Returns

The eigenvalue of the (m,n)-mode.

Return type

complex