treams.CylindricalWaveBasis

class treams.CylindricalWaveBasis(modes, positions=None)

Basis of cylindrical waves.

Functions of the cylindrical wave basis are defined by the z-components of the wave vector kz and the angular momentum m as well as the polarization pol. If the basis is defined with respect to a single origin it is referred to as “global”, if it contains multiple origins it is referred to as “local”. In a local basis an additional position index pidx is used to link the modes to one of the specified positions.

For cylindrical waves there exist multiple Polarizations and they can be separated into incident and scattered fields. Depending on these combinations the basis modes refer to one of the functions vcw_A(), vcw_rA(), vcw_M(), vcw_rM(), vcw_N(), or vcw_rN().

Parameters:

• modes (array-like) – A tuple containing a list for each of kz, m, and pol or pidx, kz, m, and``pol``.

• positions (array-like, optional) – The positions of the origins for the specified modes. Defaults to [[0, 0, 0]].

pidx

Integer referring to a row in positions.

Type:

array-like

kz

Real valued z-component of the wave vector.

Type:

array-like

m

Integer angular momentum projection onto the z-axis.

Type:

array-like

pol

Polarization, see also Polarizations.

Type:

array-like

Attributes

isglobal	Basis is defined with respect to a single (global) origin.
positions	Positions of the modes' origins.

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)
count(value)
default(kzs, mmax[, nmax, positions])	Default basis for the given z-components of wave vector and angular momentum.
defaultdim(nkz, mmax[, nmax])	Default number of modes for a given mulipolar order.
defaultmmax(dim[, nkz, nmax])	Calculate the default mode order for a given length.
diffr_orders(kz, mmax, lattice, bmax[, ...])	Create a basis set for a system periodic in the z-direction.
index(value, [start, [stop]])	Raises ValueError if the value is not present.
isdisjoint(other)	Return True if two sets have a null intersection.
__le__(other)	Return self<=value.
__lt__(other)	Return self<value.
__str__()	Return str(self).
__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)