CellTraits.h

Go to the documentation of this file.

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef vtk_m_CellTraits_h
#define vtk_m_CellTraits_h
 
#include <vtkm/CellShape.h>
 
namespace vtkm
{
 
template <vtkm::IdComponent dimension>
struct CellTopologicalDimensionsTag
{
};
 
struct CellTraitsTagSizeFixed
{
};
 
struct CellTraitsTagSizeVariable
{
};
 
template <class CellTag>
struct CellTraits
#ifdef VTKM_DOXYGEN_ONLY
{
  static const vtkm::IdComponent TOPOLOGICAL_DIMENSIONS = 3;
 
  using TopologicalDimensionsTag = vtkm::CellTopologicalDimensionsTag<TOPOLOGICAL_DIMENSIONS>;
 
  using IsSizeFixed = vtkm::CellTraitsTagSizeFixed;
 
  static constexpr vtkm::IdComponent NUM_POINTS = 3;
};
#else  // VTKM_DOXYGEN_ONLY
  ;
#endif // VTKM_DOXYGEN_ONLY
 
//-----------------------------------------------------------------------------
 
// Define traits for every cell type.
 
#define VTKM_DEFINE_CELL_TRAITS(name, dimensions, numPoints)                                     \
  template <>                                                                                    \
  struct CellTraits<vtkm::CellShapeTag##name>                                                    \
  {                                                                                              \
    static constexpr vtkm::IdComponent TOPOLOGICAL_DIMENSIONS = dimensions;                      \
    using TopologicalDimensionsTag = vtkm::CellTopologicalDimensionsTag<TOPOLOGICAL_DIMENSIONS>; \
    using IsSizeFixed = vtkm::CellTraitsTagSizeFixed;                                            \
    static constexpr vtkm::IdComponent NUM_POINTS = numPoints;                                   \
  }
 
#define VTKM_DEFINE_CELL_TRAITS_VARIABLE(name, dimensions)                                       \
  template <>                                                                                    \
  struct CellTraits<vtkm::CellShapeTag##name>                                                    \
  {                                                                                              \
    static constexpr vtkm::IdComponent TOPOLOGICAL_DIMENSIONS = dimensions;                      \
    using TopologicalDimensionsTag = vtkm::CellTopologicalDimensionsTag<TOPOLOGICAL_DIMENSIONS>; \
    using IsSizeFixed = vtkm::CellTraitsTagSizeVariable;                                         \
  }
 
VTKM_DEFINE_CELL_TRAITS(Empty, 0, 0);
VTKM_DEFINE_CELL_TRAITS(Vertex, 0, 1);
//VTKM_DEFINE_CELL_TRAITS_VARIABLE(PolyVertex, 0);
VTKM_DEFINE_CELL_TRAITS(Line, 1, 2);
VTKM_DEFINE_CELL_TRAITS_VARIABLE(PolyLine, 1);
VTKM_DEFINE_CELL_TRAITS(Triangle, 2, 3);
//VTKM_DEFINE_CELL_TRAITS_VARIABLE(TriangleStrip, 2);
VTKM_DEFINE_CELL_TRAITS_VARIABLE(Polygon, 2);
//VTKM_DEFINE_CELL_TRAITS(Pixel, 2, 4);
VTKM_DEFINE_CELL_TRAITS(Quad, 2, 4);
VTKM_DEFINE_CELL_TRAITS(Tetra, 3, 4);
//VTKM_DEFINE_CELL_TRAITS(Voxel, 3, 8);
VTKM_DEFINE_CELL_TRAITS(Hexahedron, 3, 8);
VTKM_DEFINE_CELL_TRAITS(Wedge, 3, 6);
VTKM_DEFINE_CELL_TRAITS(Pyramid, 3, 5);
 
#undef VTKM_DEFINE_CELL_TRAITS
 
} // namespace vtkm
 
#endif //vtk_m_CellTraits_h