vtkTetra.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 vtkTetra_h
#define vtkTetra_h

#include "vtkCell3D.h"
#include "vtkCommonDataModelModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkLine;
class vtkTriangle;
class vtkUnstructuredGrid;
class vtkIncrementalPointLocator;

class VTKCOMMONDATAMODEL_EXPORT vtkTetra : public vtkCell3D
{
public:
  static vtkTetra* New();
  vtkTypeMacro(vtkTetra, vtkCell3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
  bool GetCentroid(double centroid[3]) const override;
  bool IsInsideOut() override;

  static constexpr vtkIdType NumberOfPoints = 4;

  static constexpr vtkIdType NumberOfEdges = 6;

  static constexpr vtkIdType NumberOfFaces = 4;

  static constexpr vtkIdType MaximumFaceSize = 3;

  static constexpr vtkIdType MaximumValence = 3;


  int GetCellType() override { return VTK_TETRA; }
  int GetNumberOfEdges() override { return 6; }
  int GetNumberOfFaces() override { return 4; }
  vtkCell* GetEdge(int edgeId) override;
  vtkCell* GetFace(int faceId) override;
  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
    vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
    vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
    double& dist2, double weights[]) override;
  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
    double pcoords[3], int& subId) override;
  int TriangulateLocalIds(int index, vtkIdList* ptIds) override;
  void Derivatives(
    int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
  double* GetParametricCoords() override;

  VTK_DEPRECATED_IN_9_7_0("Use vtkMarchingCellsContourCases::GetTetraCase instead.")
  static int* GetTriangleCases(int caseId);

  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;

  int GetParametricCenter(double pcoords[3]) override;

  double GetParametricDistance(const double pcoords[3]) override;

  static void TetraCenter(double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);

  static double Circumsphere(
    double x1[3], double x2[3], double x3[3], double x4[3], double center[3]);

  static double Insphere(double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);

  static int BarycentricCoords(
    double x[3], double x1[3], double x2[3], double x3[3], double x4[3], double bcoords[4]);

  static double ComputeVolume(double p1[3], double p2[3], double p3[3], double p4[3]);

  int JacobianInverse(double** inverse, double derivs[12]);

  static void InterpolationFunctions(const double pcoords[3], double weights[4]);
  static void InterpolationDerivs(const double pcoords[3], double derivs[12]);

  void InterpolateFunctions(const double pcoords[3], double weights[4]) override
  {
    vtkTetra::InterpolationFunctions(pcoords, weights);
  }
  void InterpolateDerivs(const double pcoords[3], double derivs[12]) override
  {
    vtkTetra::InterpolationDerivs(pcoords, derivs);
  }


  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(3);

  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);

  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(3);

  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);

  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);

  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);

  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);

protected:
  vtkTetra();
  ~vtkTetra() override = default;

  vtkSmartPointer<vtkLine> Line;
  vtkSmartPointer<vtkTriangle> Triangle;

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

inline int vtkTetra::GetParametricCenter(double pcoords[3])
{
  pcoords[0] = pcoords[1] = pcoords[2] = 0.25;
  return 0;
}

VTK_ABI_NAMESPACE_END
#endif