acoustotreams.ScalarSphericalWaveBasis

class acoustotreams.ScalarSphericalWaveBasis(modes, positions=None)[source]

Basis of scalar spherical waves.

Functions of the spherical wave basis are defined by their degree l and 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.

Spherical waves can be separated into regular and singular modes, which describe incident and scattered fields, respectively. Therefore, the basis modes refer to one of the functions, ssw_rPsi() or ssw_Psi(), respectively.

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

  • positions (array_like, optional) – The 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

l

Degree as an integer \(l \geq 0\)

Type:

array_like

m

Order as an integer \(m \leq |l|\).

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(lmax[, nmax, positions])

Default basis for a given maximum multipolar degree.

defaultdim(lmax[, nmax])

Calculate the number of modes for a given mulipolar degree.

defaultlmax(dim[, nmax])

Calculate the maximum degree for a given number of modes.

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.