vtkMeshQuality.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkMeshQuality.h
  Language:  C++

  Copyright 2003-2006 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
  license for use of this work by or on behalf of the
  U.S. Government. Redistribution and use in source and binary forms, with
  or without modification, are permitted provided that this Notice and any
  statement of authorship are reproduced on all copies.

  Contact: dcthomp@sandia.gov,pppebay@sandia.gov

=========================================================================*/
#ifndef vtkMeshQuality_h
#define vtkMeshQuality_h

#include "vtkFiltersVerdictModule.h" // For export macro
#include "vtkDataSetAlgorithm.h"

class vtkCell;
class vtkDataArray;

#define VTK_QUALITY_EDGE_RATIO 0
#define VTK_QUALITY_ASPECT_RATIO 1
#define VTK_QUALITY_RADIUS_RATIO 2
#define VTK_QUALITY_ASPECT_FROBENIUS 3
#define VTK_QUALITY_MED_ASPECT_FROBENIUS 4
#define VTK_QUALITY_MAX_ASPECT_FROBENIUS 5
#define VTK_QUALITY_MIN_ANGLE 6
#define VTK_QUALITY_COLLAPSE_RATIO 7
#define VTK_QUALITY_MAX_ANGLE 8
#define VTK_QUALITY_CONDITION 9
#define VTK_QUALITY_SCALED_JACOBIAN 10
#define VTK_QUALITY_SHEAR 11
#define VTK_QUALITY_RELATIVE_SIZE_SQUARED 12
#define VTK_QUALITY_SHAPE 13
#define VTK_QUALITY_SHAPE_AND_SIZE 14
#define VTK_QUALITY_DISTORTION 15
#define VTK_QUALITY_MAX_EDGE_RATIO 16
#define VTK_QUALITY_SKEW 17
#define VTK_QUALITY_TAPER 18
#define VTK_QUALITY_VOLUME 19
#define VTK_QUALITY_STRETCH 20
#define VTK_QUALITY_DIAGONAL 21
#define VTK_QUALITY_DIMENSION 22
#define VTK_QUALITY_ODDY 23
#define VTK_QUALITY_SHEAR_AND_SIZE 24
#define VTK_QUALITY_JACOBIAN 25
#define VTK_QUALITY_WARPAGE 26
#define VTK_QUALITY_ASPECT_GAMMA 27
#define VTK_QUALITY_AREA 28
#define VTK_QUALITY_ASPECT_BETA 29

class VTKFILTERSVERDICT_EXPORT vtkMeshQuality : public vtkDataSetAlgorithm
{
public:
  void PrintSelf(ostream& os, vtkIndent indent) override;
  vtkTypeMacro(vtkMeshQuality,vtkDataSetAlgorithm);
  static vtkMeshQuality* New();


  vtkSetMacro(SaveCellQuality,vtkTypeBool);
  vtkGetMacro(SaveCellQuality,vtkTypeBool);
  vtkBooleanMacro(SaveCellQuality,vtkTypeBool);


  vtkSetMacro(TriangleQualityMeasure,int);
  vtkGetMacro(TriangleQualityMeasure,int);
  void SetTriangleQualityMeasureToArea()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_AREA );
  }
  void SetTriangleQualityMeasureToEdgeRatio()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_EDGE_RATIO );
  }
  void SetTriangleQualityMeasureToAspectRatio()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_ASPECT_RATIO );
  }
  void SetTriangleQualityMeasureToRadiusRatio()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_RADIUS_RATIO );
  }
  void SetTriangleQualityMeasureToAspectFrobenius()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_ASPECT_FROBENIUS );
  }
  void SetTriangleQualityMeasureToMinAngle()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_MIN_ANGLE );
  }
  void SetTriangleQualityMeasureToMaxAngle()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_MAX_ANGLE );
  }
  void SetTriangleQualityMeasureToCondition()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_CONDITION );
  }
  void SetTriangleQualityMeasureToScaledJacobian()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_SCALED_JACOBIAN );
  }
  void SetTriangleQualityMeasureToRelativeSizeSquared()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_RELATIVE_SIZE_SQUARED );
  }
  void SetTriangleQualityMeasureToShape()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_SHAPE );
  }
  void SetTriangleQualityMeasureToShapeAndSize()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_SHAPE_AND_SIZE );
  }
  void SetTriangleQualityMeasureToDistortion()
  {
    this->SetTriangleQualityMeasure( VTK_QUALITY_DISTORTION );
  }


  vtkSetMacro(QuadQualityMeasure,int);
  vtkGetMacro(QuadQualityMeasure,int);
  void SetQuadQualityMeasureToEdgeRatio()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_EDGE_RATIO );
  }
  void SetQuadQualityMeasureToAspectRatio()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_ASPECT_RATIO );
  }
  void SetQuadQualityMeasureToRadiusRatio()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_RADIUS_RATIO );
  }
  void SetQuadQualityMeasureToMedAspectFrobenius()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_MED_ASPECT_FROBENIUS );
  }
  void SetQuadQualityMeasureToMaxAspectFrobenius()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_MAX_ASPECT_FROBENIUS );
  }
  void SetQuadQualityMeasureToMaxEdgeRatios()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_MAX_EDGE_RATIO );
  }
  void SetQuadQualityMeasureToSkew()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_SKEW );
  }
  void SetQuadQualityMeasureToTaper()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_TAPER );
  }
  void SetQuadQualityMeasureToWarpage()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_WARPAGE );
  }
  void SetQuadQualityMeasureToArea()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_AREA );
  }
  void SetQuadQualityMeasureToStretch()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_STRETCH );
  }
  void SetQuadQualityMeasureToMinAngle()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_MIN_ANGLE );
  }
  void SetQuadQualityMeasureToMaxAngle()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_MAX_ANGLE );
  }
  void SetQuadQualityMeasureToOddy()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_ODDY );
  }
  void SetQuadQualityMeasureToCondition()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_CONDITION );
  }
  void SetQuadQualityMeasureToJacobian()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_JACOBIAN );
  }
  void SetQuadQualityMeasureToScaledJacobian()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_SCALED_JACOBIAN );
  }
  void SetQuadQualityMeasureToShear()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_SHEAR );
  }
  void SetQuadQualityMeasureToShape()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_SHAPE );
  }
  void SetQuadQualityMeasureToRelativeSizeSquared()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_RELATIVE_SIZE_SQUARED );
  }
  void SetQuadQualityMeasureToShapeAndSize()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_SHAPE_AND_SIZE );
  }
  void SetQuadQualityMeasureToShearAndSize()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_SHEAR_AND_SIZE );
  }
  void SetQuadQualityMeasureToDistortion()
  {
    this->SetQuadQualityMeasure( VTK_QUALITY_DISTORTION );
  }


  vtkSetMacro(TetQualityMeasure,int);
  vtkGetMacro(TetQualityMeasure,int);
  void SetTetQualityMeasureToEdgeRatio()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_EDGE_RATIO );
  }
  void SetTetQualityMeasureToAspectRatio()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_ASPECT_RATIO );
  }
  void SetTetQualityMeasureToRadiusRatio()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_RADIUS_RATIO );
  }
  void SetTetQualityMeasureToAspectFrobenius()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_ASPECT_FROBENIUS );
  }
  void SetTetQualityMeasureToMinAngle()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_MIN_ANGLE );
  }
  void SetTetQualityMeasureToCollapseRatio()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_COLLAPSE_RATIO );
  }
  void SetTetQualityMeasureToAspectBeta()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_ASPECT_BETA );
  }
  void SetTetQualityMeasureToAspectGamma()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_ASPECT_GAMMA );
  }
  void SetTetQualityMeasureToVolume()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_VOLUME );
  }
  void SetTetQualityMeasureToCondition()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_CONDITION );
  }
  void SetTetQualityMeasureToJacobian()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_JACOBIAN );
  }
  void SetTetQualityMeasureToScaledJacobian()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_SCALED_JACOBIAN );
  }
  void SetTetQualityMeasureToShape()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_SHAPE );
  }
  void SetTetQualityMeasureToRelativeSizeSquared()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_RELATIVE_SIZE_SQUARED );
  }
  void SetTetQualityMeasureToShapeAndSize()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_SHAPE_AND_SIZE );
  }
  void SetTetQualityMeasureToDistortion()
  {
    this->SetTetQualityMeasure( VTK_QUALITY_DISTORTION );
  }


  vtkSetMacro(HexQualityMeasure,int);
  vtkGetMacro(HexQualityMeasure,int);
  void SetHexQualityMeasureToEdgeRatio()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_EDGE_RATIO );
  }
  void SetHexQualityMeasureToMedAspectFrobenius()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_MED_ASPECT_FROBENIUS );
  }
  void SetHexQualityMeasureToMaxAspectFrobenius()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_MAX_ASPECT_FROBENIUS );
  }
  void SetHexQualityMeasureToMaxEdgeRatios()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_MAX_EDGE_RATIO );
  }
  void SetHexQualityMeasureToSkew()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_SKEW );
  }
  void SetHexQualityMeasureToTaper()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_TAPER );
  }
  void SetHexQualityMeasureToVolume()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_VOLUME );
  }
  void SetHexQualityMeasureToStretch()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_STRETCH );
  }
  void SetHexQualityMeasureToDiagonal()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_DIAGONAL );
  }
  void SetHexQualityMeasureToDimension()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_DIMENSION );
  }
  void SetHexQualityMeasureToOddy()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_ODDY );
  }
  void SetHexQualityMeasureToCondition()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_CONDITION );
  }
  void SetHexQualityMeasureToJacobian()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_JACOBIAN );
  }
  void SetHexQualityMeasureToScaledJacobian()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_SCALED_JACOBIAN );
  }
  void SetHexQualityMeasureToShear()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_SHEAR );
  }
  void SetHexQualityMeasureToShape()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_SHAPE );
  }
  void SetHexQualityMeasureToRelativeSizeSquared()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_RELATIVE_SIZE_SQUARED );
  }
  void SetHexQualityMeasureToShapeAndSize()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_SHAPE_AND_SIZE );
  }
  void SetHexQualityMeasureToShearAndSize()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_SHEAR_AND_SIZE );
  }
  void SetHexQualityMeasureToDistortion()
  {
    this->SetHexQualityMeasure( VTK_QUALITY_DISTORTION );
  }

  static double TriangleArea( vtkCell* cell );

  static double TriangleEdgeRatio( vtkCell* cell );

  static double TriangleAspectRatio( vtkCell* cell );

  static double TriangleRadiusRatio( vtkCell* cell );

  static double TriangleAspectFrobenius( vtkCell* cell );

  static double TriangleMinAngle( vtkCell* cell );

  static double TriangleMaxAngle( vtkCell* cell );

  static double TriangleCondition( vtkCell* cell );

  static double TriangleScaledJacobian( vtkCell* cell );

  static double TriangleRelativeSizeSquared( vtkCell* cell );

  static double TriangleShape( vtkCell* cell );

  static double TriangleShapeAndSize( vtkCell* cell );

  static double TriangleDistortion( vtkCell* cell );

  static double QuadEdgeRatio( vtkCell* cell );

  static double QuadAspectRatio( vtkCell* cell );

  static double QuadRadiusRatio( vtkCell* cell );

  static double QuadMedAspectFrobenius( vtkCell* cell );

  static double QuadMaxAspectFrobenius( vtkCell* cell );

  static double QuadMinAngle( vtkCell* cell );

  static double QuadMaxEdgeRatios( vtkCell* cell );
  static double QuadSkew( vtkCell* cell );
  static double QuadTaper( vtkCell* cell );
  static double QuadWarpage( vtkCell* cell );
  static double QuadArea( vtkCell* cell );
  static double QuadStretch( vtkCell* cell );
  static double QuadMaxAngle( vtkCell* cell );
  static double QuadOddy( vtkCell* cell );
  static double QuadCondition( vtkCell* cell );
  static double QuadJacobian( vtkCell* cell );
  static double QuadScaledJacobian( vtkCell* cell );
  static double QuadShear( vtkCell* cell );
  static double QuadShape( vtkCell* cell );
  static double QuadRelativeSizeSquared( vtkCell* cell );
  static double QuadShapeAndSize( vtkCell* cell );
  static double QuadShearAndSize( vtkCell* cell );
  static double QuadDistortion( vtkCell* cell );

  static double TetEdgeRatio( vtkCell* cell );

  static double TetAspectRatio( vtkCell* cell );

  static double TetRadiusRatio( vtkCell* cell );

  static double TetAspectFrobenius( vtkCell* cell );

  static double TetMinAngle( vtkCell* cell );


  static double TetCollapseRatio( vtkCell* cell );
  static double TetAspectBeta( vtkCell* cell );
  static double TetAspectGamma( vtkCell* cell );
  static double TetVolume( vtkCell* cell );
  static double TetCondition( vtkCell* cell );
  static double TetJacobian( vtkCell* cell );
  static double TetScaledJacobian( vtkCell* cell );
  static double TetShape( vtkCell* cell );
  static double TetRelativeSizeSquared( vtkCell* cell );
  static double TetShapeandSize( vtkCell* cell );
  static double TetDistortion( vtkCell* cell );

  static double HexEdgeRatio( vtkCell* cell );

  static double HexMedAspectFrobenius( vtkCell* cell );


  static double HexMaxAspectFrobenius( vtkCell* cell );
  static double HexMaxEdgeRatio( vtkCell* cell );
  static double HexSkew( vtkCell* cell );
  static double HexTaper( vtkCell* cell );
  static double HexVolume( vtkCell* cell );
  static double HexStretch( vtkCell* cell );
  static double HexDiagonal( vtkCell* cell );
  static double HexDimension( vtkCell* cell );
  static double HexOddy( vtkCell* cell );
  static double HexCondition( vtkCell* cell );
  static double HexJacobian( vtkCell* cell );
  static double HexScaledJacobian( vtkCell* cell );
  static double HexShear( vtkCell* cell );
  static double HexShape( vtkCell* cell );
  static double HexRelativeSizeSquared( vtkCell* cell );
  static double HexShapeAndSize( vtkCell* cell );
  static double HexShearAndSize( vtkCell* cell );
  static double HexDistortion( vtkCell* cell );

  virtual void SetRatio( vtkTypeBool r ) { this->SetSaveCellQuality( r ); }
  vtkTypeBool GetRatio() { return this->GetSaveCellQuality(); }
  vtkBooleanMacro(Ratio,vtkTypeBool);


  virtual void SetVolume( vtkTypeBool cv )
  {
    if ( ! ((cv != 0) ^ (this->Volume != 0)) )
    {
      return;
    }
    this->Modified();
    this->Volume = cv;
    if ( this->Volume )
    {
      this->CompatibilityModeOn();
    }
  }
  vtkTypeBool GetVolume()
  {
    return this->Volume;
  }
  vtkBooleanMacro(Volume,vtkTypeBool);


  virtual void SetCompatibilityMode( vtkTypeBool cm )
  {
    if ( !((cm != 0) ^ (this->CompatibilityMode != 0)) )
    {
      return;
    }
    this->CompatibilityMode = cm;
    this->Modified();
    if ( this->CompatibilityMode )
    {
      this->Volume = 1;
      this->TetQualityMeasure = VTK_QUALITY_RADIUS_RATIO;
    }
  }
  vtkGetMacro(CompatibilityMode,vtkTypeBool);
  vtkBooleanMacro(CompatibilityMode,vtkTypeBool);

protected:
  vtkMeshQuality();
  ~vtkMeshQuality() override;

  int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override;

  static int GetCurrentTriangleNormal( double point[3], double normal[3] );

  vtkTypeBool SaveCellQuality;
  int TriangleQualityMeasure;
  int QuadQualityMeasure;
  int TetQualityMeasure;
  int HexQualityMeasure;

  vtkTypeBool CompatibilityMode;
  vtkTypeBool Volume;

  vtkDataArray* CellNormals;
  static double CurrentTriNormal[3];

private:
  vtkMeshQuality( const vtkMeshQuality& ) = delete;
  void operator = ( const vtkMeshQuality& ) = delete;
};

#endif // vtkMeshQuality_h