acoustotreams.ScalarCylindricalWaveBasis.defaultmmax

static ScalarCylindricalWaveBasis.defaultmmax(dim, nkz=1, nmax=1)[source]

Calculate the maximum order for a given number of modes.

Return the estimated maximum value of m given the dimension of the T-matrix. This is the inverse of defaultdim(). A value of zero is returned for empty T-matrices.

Example

>>> acoustotreams.ScalarCylindricalWaveBasis.defaultmmax(len(acoustotreams.ScalarCylindricalWaveBasis.default([0], 2)), 1)
2
Parameters:

  • dim (int) – Dimension of the T-matrix, respectively number of modes.

  • nkz (int, optional) – Number of Z-components of the wave vector. Defaults to 1.

  • nmax (int, optional) – Number of scatterers. Defaults to 1.

Returns:

int