itkHexahedronCell.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkHexahedronCell_h
#define itkHexahedronCell_h
 
#include "itkQuadrilateralCell.h"
#include "itkHexahedronCellTopology.h"
#include "itkMakeFilled.h"
 
#include <array>
 
namespace itk
{
 
template <typename TCellInterface>
class ITK_TEMPLATE_EXPORT HexahedronCell
  : public TCellInterface
  , private HexahedronCellTopology
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HexahedronCell);

  itkCellCommonTypedefs(HexahedronCell);
  itkCellInheritedTypedefs(TCellInterface);

  itkOverrideGetNameOfClassMacro(HexahedronCell);

  using VertexType = VertexCell<TCellInterface>;
  using VertexAutoPointer = typename VertexType::SelfAutoPointer;

  using EdgeType = LineCell<TCellInterface>;
  using EdgeAutoPointer = typename EdgeType::SelfAutoPointer;

  using FaceType = QuadrilateralCell<TCellInterface>;
  using FaceAutoPointer = typename FaceType::SelfAutoPointer;

  static constexpr unsigned int NumberOfPoints = 8;
  static constexpr unsigned int NumberOfVertices = 8;
  static constexpr unsigned int NumberOfEdges = 12;
  static constexpr unsigned int NumberOfFaces = 6;
  static constexpr unsigned int CellDimension = 3;

  static constexpr unsigned int CellDimension3D = 3;
  static constexpr unsigned int PointDimension3D = 3;

  CellGeometryEnum
  GetType() const override
  {
    return CellGeometryEnum::HEXAHEDRON_CELL;
  }
  void
  MakeCopy(CellAutoPointer &) const override;
 
  unsigned int
  GetDimension() const override;
 
  unsigned int
  GetNumberOfPoints() const override;
 
  CellFeatureCount
  GetNumberOfBoundaryFeatures(int dimension) const override;
 
  bool
  GetBoundaryFeature(int dimension, CellFeatureIdentifier, CellAutoPointer &) override;
  void
  SetPointIds(PointIdConstIterator first) override;
 
  void
  SetPointIds(PointIdConstIterator first, PointIdConstIterator last) override;
 
  void
  SetPointId(int localId, PointIdentifier) override;
  PointIdIterator
  PointIdsBegin() override;
 
  PointIdConstIterator
  PointIdsBegin() const override;
 
  PointIdIterator
  PointIdsEnd() override;
 
  PointIdConstIterator
  PointIdsEnd() const override;

  virtual CellFeatureCount
  GetNumberOfVertices() const;
 
  virtual CellFeatureCount
  GetNumberOfEdges() const;
 
  virtual CellFeatureCount
  GetNumberOfFaces() const;
 
  virtual bool
  GetVertex(CellFeatureIdentifier, VertexAutoPointer &);
  virtual bool
  GetEdge(CellFeatureIdentifier, EdgeAutoPointer &);
  virtual bool
  GetFace(CellFeatureIdentifier, FaceAutoPointer &);

  bool
  EvaluatePosition(CoordinateType *,
                   PointsContainer *,
                   CoordinateType *,
                   CoordinateType[],
                   double *,
                   InterpolationWeightType *) override;

  itkCellVisitMacro(CellGeometryEnum::HEXAHEDRON_CELL);
 
protected:
  std::array<PointIdentifier, NumberOfPoints> m_PointIds{ MakeFilled<std::array<PointIdentifier, NumberOfPoints>>(
    NumericTraits<PointIdentifier>::max()) };
 
  void
  InterpolationDerivs(CoordinateType pcoords[Self::CellDimension],
                      CoordinateType derivs[Self::CellDimension * Self::NumberOfPoints]);
  void
  InterpolationFunctions(CoordinateType pcoords[Self::CellDimension], InterpolationWeightType sf[Self::NumberOfPoints]);
  void
  EvaluateLocation(int &                     itkNotUsed(subId),
                   PointsContainer *         points,
                   CoordinateType            pcoords[Self::CellDimension],
                   CoordinateType            x[Self::CellDimension],
                   InterpolationWeightType * weights);
 
public:
  HexahedronCell() = default;
 
  ~HexahedronCell() override = default;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHexahedronCell.hxx"
#endif
 
#endif