treams.PlaneWaveBasisByUnitVector

class treams.PlaneWaveBasisByUnitVector(modes)

Plane wave basis.

A plane wave basis is defined by a collection of wave vectors specified by the Cartesian wave vector components qx, qy, and qz normalized to \(q_x^2 + q_y^2 + q_z^2 = 1\) and the polarizations pol.

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 qx, qy, qz, and pol.

qx

X-component of the normalized wave vector.

Type:

array-like

qy

Y-component of the normalized wave vector.

Type:

array-like

qz

Z-component of the normalized wave vector.

Type:

array-like

pol

Polarization, see also Polarizations.

Type:

array-like

Attributes

isglobal

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)
bycomp(k0[, alignment, material])	Create a PlaneWaveBasisByComp.
count(value)
default(kvecs)	Default basis from the given wave vectors.
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)