acoustotreams.translate

acoustotreams.translate(r, *, basis, k0=None, material=AcousticMaterial(1.3, 343.0, 0.0), modetype=None, where=True)[source]

Translation matrix.

Translate the given basis set of modes along the translation vector.

Parameters:

  • r (array_like) – Translation vector.

  • basis (ScalarBasisSet or tuple) – Basis set. If it is a tuple of two basis sets, the output and input modes are taken accordingly; otherwise, both sets of modes are the same.

  • k0 (float, optional) – Angular wavenumber in the air. Has units of 1/r.

  • material (AcousticMaterial or tuple, optional) – Material parameters. Defaults to the air.

  • modetype (str, optional) – Mode type. Only used for ScalarPlaneWaveBasisByComp.

  • where (array_like of bool, optional) – Only evaluate specified parts of the translation matrix. The given array must have a shape that matches the output shape.