MeshToolsLib::ElementQualityMetric Class Reference

Detailed Description

Base class for calculating the quality of mesh element based on a given metric

Definition at line 30 of file ElementQualityMetric.h.

#include <ElementQualityMetric.h>

Inheritance diagram for MeshToolsLib::ElementQualityMetric:

Collaboration diagram for MeshToolsLib::ElementQualityMetric:

Public Member Functions
	ElementQualityMetric (MeshLib::Mesh const &mesh)
virtual	~ElementQualityMetric ()=default
virtual void	calculateQuality ()=0
	Calculates the quality metric for each element of the mesh.
std::vector< double > const &	getElementQuality () const
	Returns the result vector.
virtual BaseLib::Histogram< double >	getHistogram (std::size_t n_bins=0) const

Protected Attributes
double	_min = std::numeric_limits<double>::max()
double	_max = 0
MeshLib::Mesh const &	_mesh
std::vector< double >	_element_quality_metric

Constructor & Destructor Documentation

ElementQualityMetric()

MeshToolsLib::ElementQualityMetric::ElementQualityMetric ( MeshLib::Mesh const & mesh )

explicit

Definition at line 23 of file ElementQualityMetric.cpp.

    : _mesh(mesh)
{
    _element_quality_metric.resize(_mesh.getNumberOfElements(), -1.0);
}

References _element_quality_metric, _mesh, and MeshLib::Mesh::getNumberOfElements().

~ElementQualityMetric()

virtual MeshToolsLib::ElementQualityMetric::~ElementQualityMetric ( )

virtualdefault

Member Function Documentation

calculateQuality()

virtual void MeshToolsLib::ElementQualityMetric::calculateQuality ( )

pure virtual

Calculates the quality metric for each element of the mesh.

Implemented in MeshToolsLib::AngleSkewMetric, MeshToolsLib::EdgeRatioMetric, MeshToolsLib::ElementSizeMetric, MeshToolsLib::RadiusEdgeRatioMetric, and MeshToolsLib::SizeDifferenceMetric.

getElementQuality()

std::vector< double > const & MeshToolsLib::ElementQualityMetric::getElementQuality

(

)

const

Returns the result vector.

Definition at line 42 of file ElementQualityMetric.cpp.

{
    return _element_quality_metric;
}

References _element_quality_metric.

getHistogram()

BaseLib::Histogram< double > MeshToolsLib::ElementQualityMetric::getHistogram ( std::size_t n_bins = 0 ) const

virtual

Returns a histogram of the quality vector separated into the given number of bins. If no number of bins is specified, one will be calculated based on the Sturges criterium.

Definition at line 29 of file ElementQualityMetric.cpp.

{
    if (n_bins == 0)
    {
        n_bins = static_cast<std::size_t>(
            1 +
            3.3 * std::log(static_cast<float>((_mesh.getNumberOfElements()))));
    }
 
    return BaseLib::Histogram<double>(getElementQuality(), n_bins, true);
}

Member Data Documentation

_element_quality_metric

std::vector<double> MeshToolsLib::ElementQualityMetric::_element_quality_metric

protected

Definition at line 53 of file ElementQualityMetric.h.

Referenced by ElementQualityMetric(), MeshToolsLib::ElementSizeMetric::calc1dQuality(), MeshToolsLib::ElementSizeMetric::calc2dOr3dQuality(), MeshToolsLib::AngleSkewMetric::calculateQuality(), MeshToolsLib::EdgeRatioMetric::calculateQuality(), MeshToolsLib::RadiusEdgeRatioMetric::calculateQuality(), MeshToolsLib::SizeDifferenceMetric::calculateQuality(), and getElementQuality().

_max

double MeshToolsLib::ElementQualityMetric::_max = 0

protected

Definition at line 51 of file ElementQualityMetric.h.

Referenced by MeshToolsLib::ElementSizeMetric::calc1dQuality(), MeshToolsLib::ElementSizeMetric::calc2dOr3dQuality(), and MeshToolsLib::ElementSizeMetric::calculateQuality().

_mesh

MeshLib::Mesh const& MeshToolsLib::ElementQualityMetric::_mesh

protected

Definition at line 52 of file ElementQualityMetric.h.

Referenced by ElementQualityMetric(), MeshToolsLib::ElementSizeMetric::calc1dQuality(), MeshToolsLib::ElementSizeMetric::calc2dOr3dQuality(), MeshToolsLib::AngleSkewMetric::calculateQuality(), MeshToolsLib::EdgeRatioMetric::calculateQuality(), MeshToolsLib::ElementSizeMetric::calculateQuality(), MeshToolsLib::RadiusEdgeRatioMetric::calculateQuality(), MeshToolsLib::SizeDifferenceMetric::calculateQuality(), and MeshToolsLib::AngleSkewMetric::ElementQualityMetric().

_min

double MeshToolsLib::ElementQualityMetric::_min = std::numeric_limits<double>::max()

protected

Definition at line 50 of file ElementQualityMetric.h.

Referenced by MeshToolsLib::ElementSizeMetric::calc1dQuality(), MeshToolsLib::ElementSizeMetric::calc2dOr3dQuality(), and MeshToolsLib::ElementSizeMetric::calculateQuality().

---

The documentation for this class was generated from the following files:

• MeshToolsLib/MeshQuality/ElementQualityMetric.h
• MeshToolsLib/MeshQuality/ElementQualityMetric.cpp