nanomesh.metrics

Module to compute cell quality metrics.

Classes:

Metric(metric)

Factory function for metrics using pyvista.

Functions:

calculate_all_metrics(mesh[, inplace])	Calculate all available metrics.
histogram(mesh, *, metric[, ax])	Create a mesh plot with the cells are colored by the cell quality.
max_min_edge_ratio(mesh)	Calculate the ratio between the longest and shortest edge lengths of a triangle.
plot2d(mesh, *, metric[, ax])	Create a mesh plot with the cells are colored by the cell quality.

class nanomesh.metrics.Metric(metric: str)

Bases: object

Factory function for metrics using pyvista.

Parameters

metric (str) – Metric to calculate. For a full list, see pyvista.DataSet.compute_cell_quality().

nanomesh.metrics.calculate_all_metrics(mesh: Mesh, inplace: bool = False) → dict

Calculate all available metrics.

Parameters

• mesh (Mesh) – Input mesh

• inplace (bool, optional) – Updates the Mesh.cell_data attribute on the mesh with the metrics.

Returns

metrics – Return a dict with all the metrics

Return type

dict

nanomesh.metrics.histogram(mesh: Mesh, *, metric: str, ax: Optional[Axes] = None, **kwargs) → Axes

Create a mesh plot with the cells are colored by the cell quality.

Parameters

• mesh (Mesh) – Input mesh

• metric (str) – Metric to calculate.

• ax (matplotlib.axes.Axes) – If specified, ax will be used to create the subplot.

• vmin (int, float) – Set the lower/upper boundary for the color value.

• vmax (int, float) – Set the lower/upper boundary for the color value.

• cmap (str) – Set the color map.

• **kwargs – Keyword arguments passed on to matplotlib.pyplot.hist().

Returns

ax

Return type

matplotlib.axes.Axes

nanomesh.metrics.max_min_edge_ratio(mesh: Mesh) → ndarray

Calculate the ratio between the longest and shortest edge lengths of a triangle.

Parameters

mesh (Mesh) – Input mesh

Returns

quality – Array with cell qualities.

Return type

numpy.ndarray

nanomesh.metrics.plot2d(mesh: Mesh, *, metric: str, ax: Optional[Axes] = None, **kwargs) → Axes

Create a mesh plot with the cells are colored by the cell quality.

Parameters

• mesh (Mesh) – Input mesh

• metric (str) – Metric to calculate.

• ax (matplotlib.axes.Axes) – If specified, ax will be used to create the subplot.

• vmin (int, float) – Set the lower/upper boundary for the color value. Defaults to the 1st and 99th percentile, respectively.

• vmax (int, float) – Set the lower/upper boundary for the color value. Defaults to the 1st and 99th percentile, respectively.

• cmap (str) – Set the color map.

• **kwargs – Keyword arguments passed on to matplotlib.pyplot.tripcolor().

Returns

ax

Return type

matplotlib.axes.Axes