treams._operators.permute

Contents

treams._operators.permute#

treams._operators.permute(n=1, *, basis, k0=None, material=None, modetype=None, poltype=None)[source]#

Permutation matrix.

Permute the axes of a plane wave basis expansion.

Parameters:

  • n (int, optional) – Number of permutations, defaults to 1.

  • basis (treams.BasisSet or tuple) – Basis set, if it is a tuple of two basis sets the output and input modes are taken accordingly, else both sets of modes are the same.

  • k0 (float, optional) – Wave number.

  • material (treams.Material or tuple, optional) – Material parameters.

  • modetype (str, optional) – Wave mode.

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

Contents