acoustotreams.AcousticTMatrix

class acoustotreams.AcousticTMatrix(arr, ann=(), /, **kwargs)

Acoustic T-matrix with a spherical basis.

The acoustic T-matrix is a square matrix relating incident (regular) fields func:acoustotreams.special.ssw_rPsi to the corresponding scattered fields acoustotreams.special.ssw_Psi(). The modes themselves are defined in basis. Moreover, the wave number k0 and, if not air, the material material are specified.

Parameters:

• arr (float or complex, array-like) – T-matrix itself.

• k0 (float) – Wave number in air.

• basis (ScalarSphericalWaveBasis, optional) – Basis definition.

• material (AcousticMaterial, optional) – background material, defaults to air.

• lattice (Lattice, optional) – Lattice definition. If specified the T-Matrix is assumed to be periodically repeated in the defined lattice.

• kpar (list, optional) – Bloch wave vector for the effective T-Matrix.

Attributes

T	Transpose.
ann	Array annotations.
expand	Expansion matrix, see also acoustotreams.Expand.
expandlattice	Lattice expansion matrix, see also acoustotreams.ExpandLattice.
imag	Imaginary part of the array.
interaction
isglobal	Test if a T-matrix is global.
ks	Wave numbers (in medium).
latticeinteraction
ndim	Number of array dimensions.
pamplitudeff	Far-field amplitude of pressure field evaluation matrix, see also acoustotreams.PAmplitudeFF.
permute	Permutation matrix, see also acoustotreams.Permute.
pfield	Pressure field evaluation matrix, see also acoustotreams.PField.
real	Real part of the array.
rotate	Rotation matrix, see also acoustotreams.Rotate.
shape	Array shape.
size	Array size.
translate	Translation matrix, see also acoustotreams.Translate.
vfield	Velocity field evaluation matrix, see also acoustotreams.VField.
xs_ext_avg	Rotation averaged extinction cross section.
xs_sca_avg	Rotation averaged scattering cross section.

Methods

__abs__()
__add__(other)
__and__(other)
__array__([dtype])	Convert to an numpy array.
__array_function__(func, types, args, kwargs)	Function calls on the array.
__array_ufunc__(ufunc, method, *inputs, **kwargs)	Implement ufunc API.
__divmod__(other)
__eq__(other)	Return self==value.
__floordiv__(other)
__ge__(other)	Return self>=value.
__getitem__(key)	Get an item from the AnnotatedArray.
__gt__(other)	Return self>value.
__invert__()
__le__(other)	Return self<=value.
__len__()
__lshift__(other)
__lt__(other)	Return self<value.
__matmul__(other)
__mod__(other)
__mul__(other)
__ne__(other)	Return self!=value.
__neg__()
__or__(other)	Return self|value.
__pos__()
__pow__(other)
__repr__()	String representation.
__rshift__(other)
__setitem__(key, value)	Set values.
__str__()	String of the array itself.
__sub__(other)
__truediv__(other)
__xor__(other)
all([axis, dtype, out, keepdims, where])	Test if all elements (along an axis) are True.
any([axis, dtype, out, keepdims, where])	Test if any element (along an axis) is True.
astype(*args, **kwargs)	Return array as given type.
cluster(tmats, positions)	Block-diagonal T-matrix of multiple objects.
conj(*args, **kwargs)	Complex conjugate elementwise.
conjugate(*args, **kwargs)	Complex conjugate elementwise.
cumprod([axis, dtype, out])	Cumulative product of elements (along an axis).
cumsum([axis, dtype, out])	Cumulative sum of elements (along an axis).
diagonal([offset, axis1, axis2])	Get the diagonal of the array.
flatten([order])	Flatten array to one dimension.
max([axis, out, keepdims, initial, where])	Maximum (along an axis).
min([axis, out, keepdims, initial, where])	Minimum (along an axis).
prod([axis, dtype, out, keepdims, initial, ...])	Product of elements (along an axis).
relax(*args[, mro])	Try creating AnnotatedArray subclasses if possible.
sca(inc)	Expansion coefficients of the scattered field.
sphere(lmax, k0, radii, materials)	Acoustic T-Matrix of a sphere.
sum([axis, dtype, out, keepdims, initial, where])	Sum of elements (along an axis).
swapaxes(axis1, axis2)
trace([offset, axis1, axis2, dtype, out])	Trace of an array.
transpose([axes])	Transpose array dimensions.
valid_points(grid, radii)	Points on the grid where the expansion is valid.
xs(inc[, flux])	Scattering and extinction cross section.
__pow__(other)
__ne__(other)	Return self!=value.
__sub__(other)
__mul__(other)
__rshift__(other)
__add__(other)
__truediv__(other)
__repr__()	String representation.
__invert__()
__ge__(other)	Return self>=value.
__array__([dtype])	Convert to an numpy array.
__lt__(other)	Return self<value.
__le__(other)	Return self<=value.
__setitem__(key, value)	Set values.
__floordiv__(other)
__array_ufunc__(ufunc, method, *inputs, **kwargs)	Implement ufunc API.
__array_function__(func, types, args, kwargs)	Function calls on the array.
__matmul__(other)
__len__()
__lshift__(other)
__str__()	String of the array itself.
__eq__(other)	Return self==value.
__neg__()
__xor__(other)
__or__(other)	Return self|value.
__gt__(other)	Return self>value.
__abs__()
__divmod__(other)
__pos__()
__and__(other)
__mod__(other)