VTK-m  2.0
SetArcsSetSuperAndHypernodeArcs.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_set_arcs_set_super_and_hypernode_arcs_h
54 #define vtk_m_worklet_contourtree_augmented_active_graph_set_arcs_set_super_and_hypernode_arcs_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(
73  WholeArrayIn graphGlobalIndex, // (input) global index from the graph
74  WholeArrayIn graphHyperarcs, // (input) hyperarcs from the portal
75  WholeArrayIn graphHyperID, // (input) active graph hyperID
76  WholeArrayOut treeArcs, // (output) arcs of the tree
77  WholeArrayOut treeSuperparents); // (output) superparents of the tree
78  typedef void ExecutionSignature(_1, InputIndex, _2, _3, _4, _5);
79  using InputDomain = _1;
80 
81  // Default Constructor
84 
85  template <typename InFieldPortalType, typename OutFieldPortalType>
86  VTKM_EXEC void operator()(const InFieldPortalType& graphGlobalIndexPortal,
87  const vtkm::Id graphVertex,
88  const InFieldPortalType& graphHyperarcsPortal,
89  const InFieldPortalType& graphHyperIDPortal,
90  const OutFieldPortalType& treeArcsPortal,
91  const OutFieldPortalType& treeSuperparentsPortal) const
92  {
93  vtkm::Id graphTarget = graphHyperarcsPortal.Get(graphVertex);
94  // ignore all regular points
95  if (!IsSupernode(graphTarget))
96  return;
97 
98  // copy the target to the arcs array
99  vtkm::Id nodeID = graphGlobalIndexPortal.Get(graphVertex);
100  if (NoSuchElement(graphTarget))
101  { // trunk hypernode
102  treeArcsPortal.Set(nodeID, ((vtkm::Id)NO_SUCH_ELEMENT) | IS_HYPERNODE | IS_SUPERNODE);
103  treeSuperparentsPortal.Set(nodeID, graphHyperIDPortal.Get(graphVertex));
104  } // trunk hypernode
105  else if (IsHypernode(graphTarget))
106  { // hypernode
107  treeArcsPortal.Set(
108  nodeID, graphGlobalIndexPortal.Get(MaskedIndex(graphTarget)) | IS_HYPERNODE | IS_SUPERNODE);
109  treeSuperparentsPortal.Set(nodeID, graphHyperIDPortal.Get(graphVertex));
110  } // hypernode
111  else
112  { // supernode
113  treeArcsPortal.Set(nodeID,
114  graphGlobalIndexPortal.Get(MaskedIndex(graphTarget)) | IS_SUPERNODE);
115  } // supernode
116 
117  // In serial this worklet implements the following operation
118  /*
119  for (indexType graphVertex = 0; graphVertex < globalIndex.size(); graphVertex++)
120  { // per graph vertex
121  // retrieve the ID stored in the hyperarcs array
122  indexType graphTarget = hyperarcs[graphVertex];
123 
124  // ignore all regular points
125  if (!IsSupernode(graphTarget))
126  continue;
127 
128  // copy the target to the arcs array
129  indexType nodeID = globalIndex[graphVertex];
130  if (NoSuchElement(graphTarget))
131  { // trunk hypernode
132  tree.Arcs[nodeID] = NO_SUCH_ELEMENT | IS_HYPERNODE | IS_SUPERNODE;
133  tree.Superparents[nodeID] = hyperID[graphVertex];
134  } // trunk hypernode
135  else if (IsHypernode(graphTarget))
136  { // hypernode
137  tree.Arcs[nodeID] = globalIndex[MaskedIndex(graphTarget)] | IS_HYPERNODE | IS_SUPERNODE;
138  tree.Superparents[nodeID] = hyperID[graphVertex];
139  } // hypernode
140  else
141  { // supernode
142  tree.Arcs[nodeID] = globalIndex[MaskedIndex(graphTarget)] | IS_SUPERNODE;
143  } // supernode
144 
145  } // per graph vertex
146  */
147  }
148 
149 }; // SetArcsSetSuperAndHypernodeArcs
150 
151 } // namespace active_graph_inc
152 } // namespace contourtree_augmented
153 } // namespace worklet
154 } // namespace vtkm
155 
156 #endif
vtkm::worklet::contourtree_augmented::IsHypernode
VTKM_EXEC_CONT bool IsHypernode(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:115
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
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::SetArcsSetSuperAndHypernodeArcs::SetArcsSetSuperAndHypernodeArcs
VTKM_EXEC_CONT SetArcsSetSuperAndHypernodeArcs()
Definition: SetArcsSetSuperAndHypernodeArcs.h:83
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::contourtree_augmented::NoSuchElement
VTKM_EXEC_CONT bool NoSuchElement(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:97
vtkm::worklet::contourtree_augmented::active_graph_inc::SetArcsSetSuperAndHypernodeArcs::ExecutionSignature
void ExecutionSignature(_1, InputIndex, _2, _3, _4, _5)
Definition: SetArcsSetSuperAndHypernodeArcs.h:78
vtkm::worklet::contourtree_augmented::active_graph_inc::SetArcsSetSuperAndHypernodeArcs::InputDomain
_1 InputDomain
Definition: SetArcsSetSuperAndHypernodeArcs.h:79
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::SetArcsSetSuperAndHypernodeArcs::operator()
VTKM_EXEC void operator()(const InFieldPortalType &graphGlobalIndexPortal, const vtkm::Id graphVertex, const InFieldPortalType &graphHyperarcsPortal, const InFieldPortalType &graphHyperIDPortal, const OutFieldPortalType &treeArcsPortal, const OutFieldPortalType &treeSuperparentsPortal) const
Definition: SetArcsSetSuperAndHypernodeArcs.h:86
vtkm::worklet::contourtree_augmented::IsSupernode
VTKM_EXEC_CONT bool IsSupernode(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:109
vtkm::exec::arg::InputIndex
The ExecutionSignature tag to use to get the input index.
Definition: InputIndex.h:42
vtkm::worklet::contourtree_augmented::NO_SUCH_ELEMENT
constexpr vtkm::Id NO_SUCH_ELEMENT
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:73
vtkm::worklet::contourtree_augmented::IS_HYPERNODE
constexpr vtkm::Id IS_HYPERNODE
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:76
vtkm::worklet::contourtree_augmented::active_graph_inc::SetArcsSetSuperAndHypernodeArcs::ControlSignature
void ControlSignature(WholeArrayIn graphGlobalIndex, WholeArrayIn graphHyperarcs, WholeArrayIn graphHyperID, WholeArrayOut treeArcs, WholeArrayOut treeSuperparents)
Definition: SetArcsSetSuperAndHypernodeArcs.h:72
vtkm::worklet::contourtree_augmented::active_graph_inc::SetArcsSetSuperAndHypernodeArcs
Definition: SetArcsSetSuperAndHypernodeArcs.h:69
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38