cashocs.geometry.MeshQuality#

class cashocs.geometry.MeshQuality[source]#

Bases: object

A class used to compute the quality of a mesh.

All quality measures have values in \([0,1]\), where 1 corresponds to the reference (optimal) element, and 0 corresponds to degenerate elements.

Methods Summary

avg(calculator, mesh)

Computes the average mesh quality.

min(calculator, mesh)

Computes the minimum mesh quality.

quantile(calculator, mesh, quantile)

Computes the mesh quality based on a given quantile.

Methods Documentation

classmethod avg(
calculator: MeshQualityCalculator,
mesh: fenics.Mesh,
) → float[source]#

Computes the average mesh quality.

Parameters:

  • calculator (MeshQualityCalculator) – The calculator used to compute the mesh quality.

  • mesh (fenics.Mesh) – The mesh under investigation.

Returns:

The average mesh quality according to the measure used.

Return type:

float

classmethod min(
calculator: MeshQualityCalculator,
mesh: fenics.Mesh,
) → float[source]#

Computes the minimum mesh quality.

Parameters:

  • calculator (MeshQualityCalculator) – The calculator used to compute the mesh quality.

  • mesh (fenics.Mesh) – The mesh under investigation.

Returns:

The minimum mesh quality according to the measure used.

Return type:

float

classmethod quantile(
calculator: MeshQualityCalculator,
mesh: fenics.Mesh,
quantile: float,
) → float[source]#

Computes the mesh quality based on a given quantile.

Parameters:

  • calculator (MeshQualityCalculator) – The calculator used to compute the mesh quality.

  • mesh (fenics.Mesh) – The computational mesh.

  • quantile (float) – The desired quantile for which the mesh quality should be computed.

Returns:

The mesh quality according to the specified quantile.

Return type:

float