fiesta.disperse.Filament.characterize_filament#

Filament.characterize_filament(avg, cylinder_radius, npoints=None, verbose=False, plot_filament=False, length_unit=Unit('cm'))[source]#

Function to query all simulation cells around the filament, based on source ArepoVoronoiGrid.

The function splits the filament into equidistant npoints, joining them by cylinders of radius cylinder_radius. All AREPO cells within these cylinders are considered “part” of the filament. The indices of the cells are then stored as the instance variable arepo_ids, and the cylinder_radius sets the instance variable radius.

Note that double-counting is not corrected for in the indices. In order to do this, try np.unique(np.hstack(arepo_ids)).

Variables:

  • avg (ArepoVoronoiGrid) – Source ArepoVoronoiGrid to use for characterizing the filament.

  • cylinder_radius (float or Quantity) – Radius of cylinder to query AREPO cells within. If not a Quantity, assumed to be in u.cm units.

  • npoints (int, optional) – Number of points to split the filament into. If None (default), then the sampling points samps are used.

  • verbose (bool, optional) – If True, prints output during filament characterization. Default value is False.

  • plot_filament (bool, optional) – If True, plots the filament along with all its AREPO cells Useful for checks! Default value is False.

  • length_unit (Unit, optional) – The unit of length to use for the plot. Default value is u.cm.