acoustotreams.ScalarPlaneWaveBasisByComp

class acoustotreams.ScalarPlaneWaveBasisByComp(modes, alignment='xy')

Partial scalar 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. 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.

Scalar plane waves refer to spw_Psi().

Parameters:

• modes (array_like) – A tuple containing a list for each of k1 and k2.

• alignment (str, optional) – Wave-vector components included in the partial basis. Defaults to “xy”, other possible values are “yz” and “zx”.

alignment

Alignment of the partial basis.

Type:

str

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)	Compares 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])	Creates an instance of complete basis ScalarPlaneWaveBasis.
count(value)
default(kpars[, alignment])	Default basis from given wave vectors.
diffr_orders(kpar, lattice, bmax)	Creates a basis set for a two-dimensional periodic system.
index(value, [start, [stop]])	value.
isdisjoint(other)	Return True if two sets have a null intersection.
kvecs(k0[, material, modetype])	Wave vectors.
permute([n])
__lt__(other)	Return self<value.
__str__()	Return str(self).
__le__(other)	Return self<=value.
__xor__(other)
__sub__(other)
__or__(other)	Return self|value.
__gt__(other)	Return self>value.
__ne__(value, /)	Return self!=value.
__and__(other)
__repr__()	String representation.
__ge__(other)	Return self>=value.