VTK-m  2.0
TransferSaddleStartsUpdateEdgeSorter.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 // Copyright (c) 2018, The Regents of the University of California, through
11 // Lawrence Berkeley National Laboratory (subject to receipt of any required approvals
12 // from the U.S. Dept. of Energy). All rights reserved.
13 //
14 // Redistribution and use in source and binary forms, with or without modification,
15 // are permitted provided that the following conditions are met:
16 //
17 // (1) Redistributions of source code must retain the above copyright notice, this
18 // list of conditions and the following disclaimer.
19 //
20 // (2) Redistributions in binary form must reproduce the above copyright notice,
21 // this list of conditions and the following disclaimer in the documentation
22 // and/or other materials provided with the distribution.
23 //
24 // (3) Neither the name of the University of California, Lawrence Berkeley National
25 // Laboratory, U.S. Dept. of Energy nor the names of its contributors may be
26 // used to endorse or promote products derived from this software without
27 // specific prior written permission.
28 //
29 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
30 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
31 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 // IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
37 // OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
38 // OF THE POSSIBILITY OF SUCH DAMAGE.
39 //
40 //=============================================================================
41 //
42 // This code is an extension of the algorithm presented in the paper:
43 // Parallel Peak Pruning for Scalable SMP Contour Tree Computation.
44 // Hamish Carr, Gunther Weber, Christopher Sewell, and James Ahrens.
45 // Proceedings of the IEEE Symposium on Large Data Analysis and Visualization
46 // (LDAV), October 2016, Baltimore, Maryland.
47 //
48 // The PPP2 algorithm and software were jointly developed by
49 // Hamish Carr (University of Leeds), Gunther H. Weber (LBNL), and
50 // Oliver Ruebel (LBNL)
51 //==============================================================================
52 
53 #ifndef vtk_m_worklet_contourtree_augmented_active_graph_transfer_saddle_starts_update_edge_sorter_h
54 #define vtk_m_worklet_contourtree_augmented_active_graph_transfer_saddle_starts_update_edge_sorter_h
55 
58 
59 
60 namespace vtkm
61 {
62 namespace worklet
63 {
64 namespace contourtree_augmented
65 {
66 namespace active_graph_inc
67 {
68 
69 
70 // Worklet to update all of the edges so that the far end resets to the result of the ascent in the previous step
72 {
73 public:
74  typedef void ControlSignature(FieldIn activeVertices, // (input) active activeVertices
75  WholeArrayIn activeEdges, // (input) active edges
76  WholeArrayIn firstEdge, // (input) first edge
77  WholeArrayIn newFirstEdge, // (input) new first edge
78  WholeArrayIn newOutDegree, // (input) new out degree
79  WholeArrayOut edgeSorter); // (output) edge sorter
80  typedef void ExecutionSignature(_1, InputIndex, _2, _3, _4, _5, _6);
81  using InputDomain = _1;
82 
83  // Default Constructor
86 
87  template <typename InFieldPortalType, typename OutFieldPortalType>
88  VTKM_EXEC void operator()(const vtkm::Id& vertexId,
89  const vtkm::Id vertex,
90  const InFieldPortalType& activeEdgesPortal,
91  const InFieldPortalType& firstEdgePortal,
92  const InFieldPortalType& newFirstEdgePortal,
93  const InFieldPortalType& newOutdegreePortal,
94  const OutFieldPortalType& edgeSorterPortal) const
95  {
96  vtkm::Id activeEdgesIdx = firstEdgePortal.Get(vertexId);
97  vtkm::Id edgeSorterIndex = newFirstEdgePortal.Get(vertex);
98 
99  // loop through edges
100  for (vtkm::Id edge = 0; edge < newOutdegreePortal.Get(vertex); ++edge)
101  { // per edge
102  // retrieve the edge ID and the far end of the edge
103  edgeSorterPortal.Set(edgeSorterIndex++, activeEdgesPortal.Get(activeEdgesIdx++));
104  } // per edge
105 
106 
107  // In serial this worklet implements the following operation
108  // for (indexType vertex = 0; vertex < activeVertices.size(); vertex++)
109  // { // per vertex
110  // // retrieve the actual vertex ID
111  // indexType vertexID = activeVertices[vertex];
112  //
113  // indexType activeEdgesIdx = firstEdge[vertexID];
114  // indexType edgeSorterIndex = newFirstEdge[vertex];
115  //
116  // // loop through edges
117  // for (indexType edge = 0; edge < newOutdegree[vertex]; ++edge)
118  // { // per edge
119  // // retrieve the edge ID and the far end of the edge
120  // edgeSorter[edgeSorterIndex++] = activeEdges[activeEdgesIdx++];
121  // } // per edge
122  // } // per vertex
123  }
124 
125 
126 }; // TransferSaddleStartsUpdateEdgeSorter
127 
128 
129 } // namespace active_graph_inc
130 } // namespace contourtree_augmented
131 } // namespace worklet
132 } // namespace vtkm
133 
134 #endif
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkm::worklet::contourtree_augmented::active_graph_inc::TransferSaddleStartsUpdateEdgeSorter::operator()
VTKM_EXEC void operator()(const vtkm::Id &vertexId, const vtkm::Id vertex, const InFieldPortalType &activeEdgesPortal, const InFieldPortalType &firstEdgePortal, const InFieldPortalType &newFirstEdgePortal, const InFieldPortalType &newOutdegreePortal, const OutFieldPortalType &edgeSorterPortal) const
Definition: TransferSaddleStartsUpdateEdgeSorter.h:88
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::contourtree_augmented::active_graph_inc::TransferSaddleStartsUpdateEdgeSorter::ExecutionSignature
void ExecutionSignature(_1, InputIndex, _2, _3, _4, _5, _6)
Definition: TransferSaddleStartsUpdateEdgeSorter.h:80
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
Types.h
vtkm::worklet::contourtree_augmented::active_graph_inc::TransferSaddleStartsUpdateEdgeSorter::ControlSignature
void ControlSignature(FieldIn activeVertices, WholeArrayIn activeEdges, WholeArrayIn firstEdge, WholeArrayIn newFirstEdge, WholeArrayIn newOutDegree, WholeArrayOut edgeSorter)
Definition: TransferSaddleStartsUpdateEdgeSorter.h:74
vtkm::worklet::contourtree_augmented::active_graph_inc::TransferSaddleStartsUpdateEdgeSorter
Definition: TransferSaddleStartsUpdateEdgeSorter.h:71
vtkm::worklet::contourtree_augmented::active_graph_inc::TransferSaddleStartsUpdateEdgeSorter::InputDomain
_1 InputDomain
Definition: TransferSaddleStartsUpdateEdgeSorter.h:81
vtkm::exec::arg::InputIndex
The ExecutionSignature tag to use to get the input index.
Definition: InputIndex.h:42
vtkm::worklet::contourtree_augmented::active_graph_inc::TransferSaddleStartsUpdateEdgeSorter::TransferSaddleStartsUpdateEdgeSorter
VTKM_EXEC_CONT TransferSaddleStartsUpdateEdgeSorter()
Definition: TransferSaddleStartsUpdateEdgeSorter.h:85
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38