bloc.cfd_pathlines.rtd#

Residence time distribution plot for CFD pathline datasets.

Functions#

plot_rtd(dataset[, ax, bins, kde, color])

Plot the residence time distribution of the CFD pathlines.

Module Contents#

bloc.cfd_pathlines.rtd.plot_rtd(dataset, ax=None, bins=20, kde=True, color='#2196F3')#

Plot the residence time distribution of the CFD pathlines.

Each path’s residence time is taken as its final time_s value. When uniform_distribution is False in the dataset metadata, a warning annotation is added stating that the sample is not statistically representative of the inlet.

Parameters:

  • dataset – Loaded pathline dataset.

  • ax – Existing axes to draw on. A new figure is created when None.

  • bins – Number of histogram bins.

  • kde – Overlay a kernel density estimate when True.

  • color – Bar and KDE line color.

Returns:

The matplotlib figure.

Return type:

plt.Figure