vtkCellQuality.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCellQuality_h
#define vtkCellQuality_h
 
#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersVerdictModule.h" // For export macro
#include "vtkMeshQuality.h"          // For QualityMeasureType
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCell;
class vtkCellQualityFunctor;
class vtkDataArray;
class vtkIdList;
class vtkPoints;
 
class VTKFILTERSVERDICT_EXPORT vtkCellQuality : public vtkDataSetAlgorithm
{
private:
  friend class vtkCellQualityFunctor;
 
public:
  void PrintSelf(ostream& os, vtkIndent indent) override;
  vtkTypeMacro(vtkCellQuality, vtkDataSetAlgorithm);
  static vtkCellQuality* New();
 
 
  using QualityMeasureTypes = vtkMeshQuality::QualityMeasureTypes;
  vtkSetEnumMacro(QualityMeasure, QualityMeasureTypes);
  virtual void SetQualityMeasure(int measure)
  {
    this->SetQualityMeasure(static_cast<QualityMeasureTypes>(measure));
  }
  vtkGetEnumMacro(QualityMeasure, QualityMeasureTypes);
  void SetQualityMeasureToArea() { this->SetQualityMeasure(QualityMeasureTypes::AREA); }
  void SetQualityMeasureToAspectFrobenius()
  {
    this->SetQualityMeasure(QualityMeasureTypes::ASPECT_FROBENIUS);
  }
  void SetQualityMeasureToAspectGamma()
  {
    this->SetQualityMeasure(QualityMeasureTypes::ASPECT_GAMMA);
  }
  void SetQualityMeasureToAspectRatio()
  {
    this->SetQualityMeasure(QualityMeasureTypes::ASPECT_RATIO);
  }
  void SetQualityMeasureToCollapseRatio()
  {
    this->SetQualityMeasure(QualityMeasureTypes::COLLAPSE_RATIO);
  }
  void SetQualityMeasureToCondition() { this->SetQualityMeasure(QualityMeasureTypes::CONDITION); }
  void SetQualityMeasureToDiagonal() { this->SetQualityMeasure(QualityMeasureTypes::DIAGONAL); }
  void SetQualityMeasureToDimension() { this->SetQualityMeasure(QualityMeasureTypes::DIMENSION); }
  void SetQualityMeasureToDistortion() { this->SetQualityMeasure(QualityMeasureTypes::DISTORTION); }
  void SetQualityMeasureToJacobian() { this->SetQualityMeasure(QualityMeasureTypes::JACOBIAN); }
  void SetQualityMeasureToMaxAngle() { this->SetQualityMeasure(QualityMeasureTypes::MAX_ANGLE); }
  void SetQualityMeasureToMaxAspectFrobenius()
  {
    this->SetQualityMeasure(QualityMeasureTypes::MAX_ASPECT_FROBENIUS);
  }
  void SetQualityMeasureToMaxEdgeRatio()
  {
    this->SetQualityMeasure(QualityMeasureTypes::MAX_EDGE_RATIO);
  }
  void SetQualityMeasureToMedAspectFrobenius()
  {
    this->SetQualityMeasure(QualityMeasureTypes::MED_ASPECT_FROBENIUS);
  }
  void SetQualityMeasureToMinAngle() { this->SetQualityMeasure(QualityMeasureTypes::MIN_ANGLE); }
  void SetQualityMeasureToOddy() { this->SetQualityMeasure(QualityMeasureTypes::ODDY); }
  void SetQualityMeasureToRadiusRatio()
  {
    this->SetQualityMeasure(QualityMeasureTypes::RADIUS_RATIO);
  }
  void SetQualityMeasureToRelativeSizeSquared()
  {
    this->SetQualityMeasure(QualityMeasureTypes::RELATIVE_SIZE_SQUARED);
  }
  void SetQualityMeasureToScaledJacobian()
  {
    this->SetQualityMeasure(QualityMeasureTypes::SCALED_JACOBIAN);
  }
  void SetQualityMeasureToShapeAndSize()
  {
    this->SetQualityMeasure(QualityMeasureTypes::SHAPE_AND_SIZE);
  }
  void SetQualityMeasureToShape() { this->SetQualityMeasure(QualityMeasureTypes::SHAPE); }
  void SetQualityMeasureToShearAndSize()
  {
    this->SetQualityMeasure(QualityMeasureTypes::SHEAR_AND_SIZE);
  }
  void SetQualityMeasureToShear() { this->SetQualityMeasure(QualityMeasureTypes::SHEAR); }
  void SetQualityMeasureToSkew() { this->SetQualityMeasure(QualityMeasureTypes::SKEW); }
  void SetQualityMeasureToStretch() { this->SetQualityMeasure(QualityMeasureTypes::STRETCH); }
  void SetQualityMeasureToTaper() { this->SetQualityMeasure(QualityMeasureTypes::TAPER); }
  void SetQualityMeasureToVolume() { this->SetQualityMeasure(QualityMeasureTypes::VOLUME); }
  void SetQualityMeasureToWarpage() { this->SetQualityMeasure(QualityMeasureTypes::WARPAGE); }
 
 
  vtkSetMacro(UnsupportedGeometry, double);
  vtkGetMacro(UnsupportedGeometry, double);
 
 
  vtkSetMacro(UndefinedQuality, double);
  vtkGetMacro(UndefinedQuality, double);
 
  double TriangleStripArea(vtkCell*);
  double PixelArea(vtkCell*);
  double PolygonArea(vtkCell*);
 
protected:
  ~vtkCellQuality() override;
  vtkCellQuality();
 
  double ComputeTriangleQuality(vtkCell*);
 
  double ComputeQuadQuality(vtkCell*);
 
  double ComputeTetQuality(vtkCell*);
 
  double ComputePyramidQuality(vtkCell*);
 
  double ComputeWedgeQuality(vtkCell*);
 
  double ComputeHexQuality(vtkCell*);
 
  double ComputeTriangleStripQuality(vtkCell*);
 
  double ComputePixelQuality(vtkCell*);
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  vtkMeshQuality::QualityMeasureTypes QualityMeasure;
 
  // Default return value for unsupported geometry
  double UnsupportedGeometry;
 
  // Default return value for qualities that are not well-defined for certain
  // types of supported geometries. e.g. volume of a triangle
  double UndefinedQuality;
 
private:
  vtkIdList* PointIds;
  vtkPoints* Points;
 
  vtkCellQuality(const vtkCellQuality&) = delete;
  void operator=(const vtkCellQuality&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkCellQuality_h