VTK-m  2.0
ConnectivityStructured.h
Go to the documentation of this file.
1 //============================================================================
2 // Copyright (c) Kitware, Inc.
3 // All rights reserved.
4 // See LICENSE.txt for details.
5 //
6 // This software is distributed WITHOUT ANY WARRANTY; without even
7 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
8 // PURPOSE. See the above copyright notice for more information.
9 //============================================================================
10 
11 #ifndef vtk_m_exec_ConnectivityStructured_h
12 #define vtk_m_exec_ConnectivityStructured_h
13 
15 #include <vtkm/Types.h>
17 
18 namespace vtkm
19 {
20 namespace exec
21 {
22 
23 template <typename VisitTopology, typename IncidentTopology, vtkm::IdComponent Dimension>
25 {
26  VTKM_IS_TOPOLOGY_ELEMENT_TAG(VisitTopology);
27  VTKM_IS_TOPOLOGY_ELEMENT_TAG(IncidentTopology);
28 
29  using InternalsType = vtkm::internal::ConnectivityStructuredInternals<Dimension>;
30 
31  using Helper =
32  vtkm::internal::ConnectivityStructuredIndexHelper<VisitTopology, IncidentTopology, Dimension>;
33 
34 public:
35  using SchedulingRangeType = typename InternalsType::SchedulingRangeType;
36 
37  ConnectivityStructured() = default;
38 
41  : Internals(src)
42  {
43  }
44 
45  ConnectivityStructured(const ConnectivityStructured& src) = default;
46 
50  : Internals(src.Internals)
51  {
52  }
53 
54 
57 
58 
59  VTKM_EXEC
60  vtkm::Id GetNumberOfElements() const { return Helper::GetNumberOfElements(this->Internals); }
61 
62  using CellShapeTag = typename Helper::CellShapeTag;
63  VTKM_EXEC
65 
66  template <typename IndexType>
67  VTKM_EXEC vtkm::IdComponent GetNumberOfIndices(const IndexType& index) const
68  {
69  return Helper::GetNumberOfIndices(this->Internals, index);
70  }
71 
72  using IndicesType = typename Helper::IndicesType;
73 
74  template <typename IndexType>
75  VTKM_EXEC IndicesType GetIndices(const IndexType& index) const
76  {
77  return Helper::GetIndices(this->Internals, index);
78  }
79 
82  {
83  return Helper::FlatToLogicalFromIndex(this->Internals, flatFromIndex);
84  }
85 
87  vtkm::Id LogicalToFlatFromIndex(const SchedulingRangeType& logicalFromIndex) const
88  {
89  return Helper::LogicalToFlatFromIndex(this->Internals, logicalFromIndex);
90  }
91 
94  {
95  return Helper::FlatToLogicalToIndex(this->Internals, flatToIndex);
96  }
97 
99  vtkm::Id LogicalToFlatToIndex(const SchedulingRangeType& logicalToIndex) const
100  {
101  return Helper::LogicalToFlatToIndex(this->Internals, logicalToIndex);
102  }
103 
106  {
107  return this->Internals.GetPointDimensions();
108  }
109 
112  {
113  return this->Internals.GetCellDimensions();
114  }
115 
118  {
119  return this->Internals.GetGlobalPointIndexStart();
120  }
121 
122  friend class ConnectivityStructured<IncidentTopology, VisitTopology, Dimension>;
123 
124 private:
126 };
127 }
128 } // namespace vtkm::exec
129 
130 #endif //vtk_m_exec_ConnectivityStructured_h
vtkm::exec::ConnectivityStructured::FlatToLogicalToIndex
VTKM_EXEC_CONT SchedulingRangeType FlatToLogicalToIndex(vtkm::Id flatToIndex) const
Definition: ConnectivityStructured.h:93
vtkm::exec::ConnectivityStructured::GetNumberOfIndices
VTKM_EXEC vtkm::IdComponent GetNumberOfIndices(const IndexType &index) const
Definition: ConnectivityStructured.h:67
vtkm::exec::ConnectivityStructured::GetNumberOfElements
VTKM_EXEC vtkm::Id GetNumberOfElements() const
Definition: ConnectivityStructured.h:60
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
ConnectivityStructuredInternals.h
Types.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::exec::ConnectivityStructured::FlatToLogicalFromIndex
VTKM_EXEC_CONT SchedulingRangeType FlatToLogicalFromIndex(vtkm::Id flatFromIndex) const
Definition: ConnectivityStructured.h:81
vtkm::exec::ConnectivityStructured::LogicalToFlatFromIndex
VTKM_EXEC_CONT vtkm::Id LogicalToFlatFromIndex(const SchedulingRangeType &logicalFromIndex) const
Definition: ConnectivityStructured.h:87
vtkm::IdComponent
vtkm::Int32 IdComponent
Represents a component ID (index of component in a vector).
Definition: Types.h:168
vtkm::exec::ConnectivityStructured::ConnectivityStructured
ConnectivityStructured()=default
vtkm::exec::ConnectivityStructured::GetGlobalPointIndexStart
VTKM_EXEC_CONT SchedulingRangeType GetGlobalPointIndexStart() const
Definition: ConnectivityStructured.h:117
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::exec::ConnectivityStructured::GetPointDimensions
VTKM_EXEC_CONT vtkm::Vec< vtkm::Id, Dimension > GetPointDimensions() const
Definition: ConnectivityStructured.h:105
vtkm::exec::ConnectivityStructured::Helper
vtkm::internal::ConnectivityStructuredIndexHelper< VisitTopology, IncidentTopology, Dimension > Helper
Definition: ConnectivityStructured.h:32
vtkm::exec::ConnectivityStructured::LogicalToFlatToIndex
VTKM_EXEC_CONT vtkm::Id LogicalToFlatToIndex(const SchedulingRangeType &logicalToIndex) const
Definition: ConnectivityStructured.h:99
vtkm::exec::ConnectivityStructured::Internals
InternalsType Internals
Definition: ConnectivityStructured.h:125
vtkm::exec::ConnectivityStructured::SchedulingRangeType
typename InternalsType::SchedulingRangeType SchedulingRangeType
Definition: ConnectivityStructured.h:35
vtkm::exec::ConnectivityStructured::CellShapeTag
typename Helper::CellShapeTag CellShapeTag
Definition: ConnectivityStructured.h:62
vtkm::exec::ConnectivityStructured::ConnectivityStructured
VTKM_EXEC_CONT ConnectivityStructured(const InternalsType &src)
Definition: ConnectivityStructured.h:40
vtkm::exec::ConnectivityStructured::GetIndices
VTKM_EXEC IndicesType GetIndices(const IndexType &index) const
Definition: ConnectivityStructured.h:75
vtkm::exec::ConnectivityStructured
Definition: ConnectivityStructured.h:24
vtkm::Vec
A short fixed-length array.
Definition: Types.h:767
vtkm::exec::ConnectivityStructured::GetCellShape
VTKM_EXEC CellShapeTag GetCellShape(vtkm::Id) const
Definition: ConnectivityStructured.h:64
vtkm::exec::ConnectivityStructured::operator=
ConnectivityStructured & operator=(const ConnectivityStructured &src)=default
vtkm::exec::ConnectivityStructured::ConnectivityStructured
VTKM_EXEC_CONT ConnectivityStructured(const ConnectivityStructured< IncidentTopology, VisitTopology, Dimension > &src)
Definition: ConnectivityStructured.h:48
vtkm::exec::ConnectivityStructured::IndicesType
typename Helper::IndicesType IndicesType
Definition: ConnectivityStructured.h:72
vtkm::exec::ConnectivityStructured::GetCellDimensions
VTKM_EXEC_CONT vtkm::Vec< vtkm::Id, Dimension > GetCellDimensions() const
Definition: ConnectivityStructured.h:111
vtkm::exec::ConnectivityStructured::InternalsType
vtkm::internal::ConnectivityStructuredInternals< Dimension > InternalsType
Definition: ConnectivityStructured.h:29
vtkm::exec::ConnectivityStructured::VTKM_IS_TOPOLOGY_ELEMENT_TAG
VTKM_IS_TOPOLOGY_ELEMENT_TAG(VisitTopology)
TopologyElementTag.h