create_histogram

MeshStatistics.create_histogram(variable: str, domain: str = 'ALL', use_percentages: bool = True, bin_units: str = '', image_file: str = '', show: bool = True) → None

Create a histogram from the mesh statistics using the matplotlib library.

Parameters

variable: str

Mesh statistics variable to use for the histogram.

domain: str, optional

Domain name to get statistics for. If not specified, statistics for all domains are read.

use_percentages: bool, optional

If not specified or set to true, display the percentage values of the bin counts for the histogram. If false, display the actual bin counts.

bin_units: str, optional

Use the provided units for the bin values (x-axis labels).

image_file: str, optional

If set, write the histogram image to the specified file. The image format is determined by the file extension e.g. “.png”.

show: bool, optional

If set to false, do not display the image on screen. Only useful if the image is being written to a file.