acoustotreams.ScalarCylindricalWaveBasis

class acoustotreams.ScalarCylindricalWaveBasis(modes, positions=None)

Basis of scalar cylindrical waves.

Functions of the cylindrical wave basis are defined by the Z-components of the wave vector kz and the order m. If the basis is defined with respect to a single expansion center, it is referred to as “global”. If it contains multiple expansion centers, 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.

Cylindrical waves can be separated into regular and singular modes, which describe incident and scattered fields, respectively. Thus, the basis modes refer to one of the functions scw_rPsi() or scw_Psi(), respectively.

Parameters:

• modes (array_like) – A tuple containing a list for each of kz and m, or pidx, kz and m.

• positions (array_like, optional) – Positions of the expansion centers for the specified modes (m). 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 (rad/m).

Type:

array_like

m

Integer order.

Type:

array_like

Attributes

isglobal	Basis is defined with respect to a single (global) expansion center.
positions	Positions of the modes' expansion centers.

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 given Z-components of the wave vector and a given maximum order.
defaultdim(nkz, mmax[, nmax])	Calculate the number of modes for a given mulipolar order.
defaultmmax(dim[, nkz, nmax])	Calculate the maximum order for a given number of modes.
diffr_orders(kz, mmax, lattice, bmax[, ...])	Creates a basis set for a system periodic in the z-direction.
index(value, [start, [stop]])	value.
isdisjoint(other)	Return True if two sets have a null intersection.
__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)
__ge__(other)	Return self>=value.