Reference

ACOUSTOTREAMS: A Python package for acoustic wave scattering based on the T-matrix method.

Classes

The top-level classes and functions allow a high-level access to the functionality.

Basis sets

ScalarCylindricalWaveBasis(modes[, positions])	Basis of scalar cylindrical waves.
ScalarPlaneWaveBasisByUnitVector(modes)	Scalar plane wave basis.
ScalarPlaneWaveBasisByComp(modes[, alignment])	Partial scalar plane wave basis.
ScalarSphericalWaveBasis(modes[, positions])	Basis of scalar spherical waves.

Matrices and Arrays

AcousticsArray(arr[, ann])	Acoustics-aware array.
AcousticSMatrix(arr[, ann])	Acoustic S-matrix for a scalar plane wave.
AcousticSMatrices(smats, **kwargs)	Collection of four acoustic S-matrices with a scalar plane wave basis.
AcousticTMatrix(arr[, ann])	Acoustic T-matrix with a spherical basis.
AcousticTMatrixC(arr[, ann])	Acoustic T-matrix with a scalar cylindrical basis.

Other

AcousticMaterial([rho, c, ct])

Material definition.

Functions

Operators

pfield(r, *, basis, k0[, material, modetype])	Pressure field.
vfield(r, *, basis, k0[, material, modetype])	Velocity field.
pamplitudeff(r, *, basis, k0[, material, ...])	Far-field amplitude of pressure field.
expand(basis[, modetype, k0, material, where])	Expansion matrix.
expandlattice([lattice, kpar, basis, ...])	Expansion matrix in lattices.
permute([n, k0, material, modetype])	Permutation matrix.
rotate(phi[, theta, psi, where])	Rotation matrix.
translate(r, *, basis[, k0, material, ...])	Translation matrix.

Scalar wave functions

cylindrical_wave_scalar(kz, m, *[, k0, ...])
plane_wave_scalar(kvec, *[, k0, basis, ...])	Array describing a scalar plane wave.
plane_wave_angle_scalar(theta, phi, **kwargs)
spherical_wave_scalar(l, m, *[, k0, basis, ...])

Functions imported from SciPy

hankel1(v, z[, out])	Hankel function of the first kind.
hankel2(v, z[, out])	Hankel function of the second kind.
jv(v, z[, out])	Bessel function of the first kind of real order and complex argument.
yv(v, z[, out])	Bessel function of the second kind of real order and complex argument.
spherical_jn(n, z[, derivative])	Spherical Bessel function of the first kind or its derivative.
spherical_yn(n, z[, derivative])	Spherical Bessel function of the second kind or its derivative.

Functions imported from treams.special, treams.misc, and treams.lattice

spherical_jn_d(n, z)	Derivative of the spherical Bessel function of the first kind.
spherical_yn_d(n, z)	Derivative of the spherical Bessel function of the second kind.

Modules

These modules provide basic functionality for transformations within one basis set, i.e. one module, like translations and rotations as well as transformations among them. The functions in there provide an intermediate stage between the purely mathematical functions, either implemented within acoustotreams or imported from treams.special and treams.lattice, and the higher-level classes and functions.

ssw	Scalar spherical wave module.
scw	Scalar cylindrical wave module.
spw	Scalar plane wave module.

Finally, a module for calculating scattering and Fresnel coefficients.

coeffs

Scattering coefficients for high-symmetry cases.

Subpackage

This subpackages allows a low-level access to the implementation of mathematical functions

special

Special (mathematical) functions.