VTK-m  2.0
BuildChainsWorklet.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_build_chains_worklet_h
54 #define vtk_m_worklet_contourtree_augmented_active_graph_build_chains_worklet_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_augmented
64 {
65 namespace active_graph_inc
66 {
67 
68 // Worklet for computing the sort indices from the sort order
70 {
71 public:
72  typedef void ControlSignature(FieldIn activeVertices, // (input) activeVertices
73  WholeArrayInOut hyperarcs); // (input/output) hyperarcs
74  typedef void ExecutionSignature(_1, InputIndex, _2);
75  using InputDomain = _1;
76 
77  // Default Constructor
80 
81  template <typename InOutFieldPortalType>
82  VTKM_EXEC void operator()(const vtkm::Id& vertexId,
83  const vtkm::Id /*vertex*/, // FIXME: Remove unused parameter?
84  const InOutFieldPortalType& hyperarcsPortal) const
85  {
86  // retrieve neighbour's ID
87  vtkm::Id neighbour = hyperarcsPortal.Get(vertexId);
88  // test for terminal vertex
89  if (IsTerminalElement(neighbour))
90  {
91  return;
92  }
93  // retrieve supernode flags
94  vtkm::Id supernodeFlag = neighbour & (IS_SUPERNODE | IS_HYPERNODE);
95  // remove the mask to get a raw index
96  neighbour = MaskedIndex(neighbour);
97  // otherwise, retrieve the double neighbour
98  vtkm::Id doubleNeighbour = hyperarcsPortal.Get(neighbour);
99  // remove it's supernode & hypernode flags, but preserve the terminal flag
100  doubleNeighbour = doubleNeighbour & (TERMINAL_ELEMENT | INDEX_MASK);
101  // and add our own supernode flag in
102  hyperarcsPortal.Set(vertexId, doubleNeighbour | supernodeFlag);
103 
104  // In serial this worklet implements the following operation
105  /*
106  for (indexType vertex = 0; vertex < activeVertices.size(); vertex++)
107  { // per vertex
108  // convert to vertex ID
109  indexType vertexID = activeVertices[vertex];
110  // retrieve neighbour's ID
111  indexType neighbour = hyperarcs[vertexID];
112  // test for terminal vertex
113  if (IsTerminalElement(neighbour))
114  continue;
115  // retrieve supernode flags
116  indexType supernodeFlag = neighbour & (IS_SUPERNODE | IS_HYPERNODE);
117  // remove the mask to get a raw index
118  neighbour = MaskedIndex(neighbour);
119  // otherwise, retrieve the double neighbour
120  indexType doubleNeighbour = hyperarcs[neighbour];
121  // remove it's supernode & hypernode flags, but preserve the terminal flag
122  doubleNeighbour = doubleNeighbour & (TERMINAL_ELEMENT | INDEX_MASK);
123  // and add our own supernode flag in
124  hyperarcs[vertexID] = doubleNeighbour | supernodeFlag;
125  } // per vertex
126 
127  */
128  }
129 
130 }; // BuildChainsWorklet
131 
132 } // namespace active_graph_inc
133 } // namespace contourtree_augmented
134 } // namespace worklet
135 } // namespace vtkm
136 
137 #endif
vtkm::worklet::contourtree_augmented::active_graph_inc::BuildChainsWorklet::ControlSignature
void ControlSignature(FieldIn activeVertices, WholeArrayInOut hyperarcs)
Definition: BuildChainsWorklet.h:72
vtkm::worklet::contourtree_augmented::INDEX_MASK
constexpr vtkm::Id INDEX_MASK
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:78
vtkm::worklet::contourtree_augmented::active_graph_inc::BuildChainsWorklet::InputDomain
_1 InputDomain
Definition: BuildChainsWorklet.h:75
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm::worklet::contourtree_augmented::IsTerminalElement
VTKM_EXEC_CONT bool IsTerminalElement(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:103
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::contourtree_augmented::active_graph_inc::BuildChainsWorklet::ExecutionSignature
void ExecutionSignature(_1, InputIndex, _2)
Definition: BuildChainsWorklet.h:74
vtkm::worklet::contourtree_augmented::active_graph_inc::BuildChainsWorklet::BuildChainsWorklet
VTKM_EXEC_CONT BuildChainsWorklet()
Definition: BuildChainsWorklet.h:79
vtkm::worklet::contourtree_augmented::active_graph_inc::BuildChainsWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &vertexId, const vtkm::Id, const InOutFieldPortalType &hyperarcsPortal) const
Definition: BuildChainsWorklet.h:82
vtkm::worklet::contourtree_augmented::TERMINAL_ELEMENT
constexpr vtkm::Id TERMINAL_ELEMENT
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:74
vtkm::worklet::contourtree_augmented::MaskedIndex
VTKM_EXEC_CONT vtkm::Id MaskedIndex(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:127
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::IS_SUPERNODE
constexpr vtkm::Id IS_SUPERNODE
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:75
vtkm::worklet::contourtree_augmented::active_graph_inc::BuildChainsWorklet
Definition: BuildChainsWorklet.h:69
vtkm::exec::arg::InputIndex
The ExecutionSignature tag to use to get the input index.
Definition: InputIndex.h:42
vtkm::worklet::contourtree_augmented::IS_HYPERNODE
constexpr vtkm::Id IS_HYPERNODE
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:76
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38