treams.PlaneWaveBasisByComp

class treams.PlaneWaveBasisByComp(modes, alignment='xy')

Partial plane wave basis.

A partial plane wave basis is defined by two wave vector components out of all three Cartesian wave vector components kx, ky, and kz and the polarizations pol. Which two components are given is specified in the alignment. This basis is mostly used for stratified media that are periodic or uniform in the two alignment directions, such that the given wave vector components correspond to the diffraction orders.

For plane waves there exist multiple Polarizations, such that these modes can refer to either vpw_A() or vpw_M() and vpw_N().

Parameters:

• modes (array-like) – A tuple containing a list for each of k1, k2, and pol.

• alignment (str, optional) – Definition which wave vector components are given. Defaults to “xy”, other possible values are “yz” and “zx”.

alignment

Alignment of the partial basis.

Type:

str

pol

Polarization, see also Polarizations.

Type:

array-like

Attributes

isglobal
kx	X-components of the wave vector.
ky	Y-components of the wave vector.
kz	Z-components of the wave vector.

Methods

__and__(other)
__eq__(other)	Compare basis sets.
__ge__(other)	Return self>=value.
__getitem__(idx)	Get a subset of the basis.
__gt__(other)	Return self>value.
__le__(other)	Return self<=value.
__len__()	Number of modes.
__lt__(other)	Return self<value.
__ne__(value, /)	Return self!=value.
__or__(other)	Return self|value.
__repr__()	String representation.
__str__()	Return str(self).
__sub__(other)
__xor__(other)
byunitvector(k0[, material, modetype])	Create a complete basis PlaneWaveBasis.
count(value)
default(kpars[, alignment])	Default basis from the given wave vectors.
diffr_orders(kpar, lattice, bmax)	Create a basis set for a two-dimensional periodic system.
index(value, [start, [stop]])	Raises ValueError if the value is not present.
isdisjoint(other)	Return True if two sets have a null intersection.
kvecs(k0[, material, modetype])	Wave vectors.
permute([n])
__le__(other)	Return self<=value.
__lt__(other)	Return self<value.
__str__()	Return str(self).
__repr__()	String representation.
__or__(other)	Return self|value.
__and__(other)
__xor__(other)
__ge__(other)	Return self>=value.
__gt__(other)	Return self>value.
__len__()	Number of modes.
__ne__(value, /)	Return self!=value.
__sub__(other)