amep.utils.dimension#

amep.utils.dimension(coords: ndarray, verbose: bool = False) int#

Returns the spatial dimension of simulation data. Requires a coordinate frame of three spatial dimension with coordinates of the unused dimensions set to a constant value.

Parameters:
  • coords (np.ndarray) – Coordinate frame.

  • verbose (bool, optional) – If True, runtime information is printed. The default is False.

Returns:

dim – Spatial dimension.

Return type:

int