Detailed Description

Interface class for handling mesh element quality metrics

Definition at line 35 of file ElementQualityInterface.h.

#include <ElementQualityInterface.h>

Collaboration diagram for MeshLib::ElementQualityInterface:

Public Member Functions
	ElementQualityInterface (MeshLib::Mesh const &mesh, MeshQualityType t)
	Constructor. More...

std::vector< double > const	getQualityVector () const
	Returns the vector containing a quality measure for each element. More...

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

int	writeHistogram (std::string const &file_name, std::size_t n_bins=0) const
	Writes a histogram of the quality vector to a specified file. More...

Private Member Functions
void	calculateElementQuality (MeshLib::Mesh const &mesh, MeshQualityType t)
	Calculates the quality of each mesh element based on the specified metric. More...

Private Attributes
MeshQualityType const	_type

MeshLib::Mesh const &	_mesh

std::unique_ptr< MeshLib::ElementQualityMetric >	_quality_tester

Constructor & Destructor Documentation

◆ ElementQualityInterface()

MeshLib::ElementQualityInterface::ElementQualityInterface	(	MeshLib::Mesh const &	mesh,
		MeshQualityType	t
	)

inline

Constructor.

Definition at line 39 of file ElementQualityInterface.h.

     : _type(t), _mesh(mesh), _quality_tester(nullptr)
     {
         calculateElementQuality(_mesh, _type);
     }

References _mesh, _type, and calculateElementQuality().

Member Function Documentation

◆ calculateElementQuality()

void MeshLib::ElementQualityInterface::calculateElementQuality	(	MeshLib::Mesh const &	mesh,
		MeshQualityType	t
	)

inlineprivate

Calculates the quality of each mesh element based on the specified metric.

Definition at line 78 of file ElementQualityInterface.h.

     {
         if (t == MeshQualityType::EDGERATIO)
             _quality_tester = std::make_unique<MeshLib::EdgeRatioMetric>(mesh);
         else if (t == MeshQualityType::ELEMENTSIZE)
             _quality_tester =
                 std::make_unique<MeshLib::ElementSizeMetric>(mesh);
         else if (t == MeshQualityType::SIZEDIFFERENCE)
             _quality_tester =
                 std::make_unique<MeshLib::SizeDifferenceMetric>(mesh);
         else if (t == MeshQualityType::EQUIANGLESKEW)
             _quality_tester = std::make_unique<MeshLib::AngleSkewMetric>(mesh);
         else if (t == MeshQualityType::RADIUSEDGERATIO)
             _quality_tester =
                 std::make_unique<MeshLib::RadiusEdgeRatioMetric>(mesh);
         else
         {
             ERR("ElementQualityInterface::calculateElementQuality(): Unknown MeshQualityType.");
             return;
         }
         _quality_tester->calculateQuality();
     }

References _quality_tester, MeshLib::EDGERATIO, MeshLib::ELEMENTSIZE, MeshLib::EQUIANGLESKEW, ERR(), MeshLib::RADIUSEDGERATIO, and MeshLib::SIZEDIFFERENCE.

Referenced by ElementQualityInterface().

◆ getHistogram()

BaseLib::Histogram<double> MeshLib::ElementQualityInterface::getHistogram ( std::size_t n_bins = 0 ) const

inline

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 57 of file ElementQualityInterface.h.

     {
         if (_quality_tester)
             return _quality_tester->getHistogram(static_cast<std::size_t>(n_bins));
  
         return BaseLib::Histogram<double>{{}};
     }

References _quality_tester.

◆ getQualityVector()

std::vector<double> const MeshLib::ElementQualityInterface::getQualityVector ( ) const

inline

Returns the vector containing a quality measure for each element.

Definition at line 46 of file ElementQualityInterface.h.

     {
         if (_quality_tester)
             return _quality_tester->getElementQuality();
  
         std::vector<double> empty_quality_vec(0);
         return empty_quality_vec;
     }

References _quality_tester.

Referenced by main(), and MainWindow::showMeshQualitySelectionDialog().

◆ writeHistogram()

int MeshLib::ElementQualityInterface::writeHistogram	(	std::string const &	file_name,
		std::size_t	n_bins = `0`
	)		const

inline

Writes a histogram of the quality vector to a specified file.

Definition at line 66 of file ElementQualityInterface.h.

     {
         if (_quality_tester == nullptr)
             return 1;
  
         BaseLib::Histogram<double> const histogram (_quality_tester->getHistogram(n_bins));
         histogram.write(file_name, _mesh.getName(), MeshQualityType2String(_type));
         return 0;
     }