VTK-m  2.0
AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.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 
54 #ifndef vtk_m_worklet_contourtree_augmented_contourtree_maker_inc_augment_merge_tree_init_new_join_splot_id_and_superparents_h
55 #define vtk_m_worklet_contourtree_augmented_contourtree_maker_inc_augment_merge_tree_init_new_join_splot_id_and_superparents_h
56 
59 
60 namespace vtkm
61 {
62 namespace worklet
63 {
64 namespace contourtree_augmented
65 {
66 namespace contourtree_maker_inc
67 {
68 
69 // Worklet for computing the sort indices from the sort order
71 {
72 public:
73  typedef void ControlSignature(
74  FieldIn contourTreeSupernodes, // (input) supernodes from the contour tree
75  WholeArrayIn joinTreeSuperparents, // (input)
76  WholeArrayIn splitTreeSuperparents, // (input)
77  WholeArrayIn joinTreeSupernodes, // (input)
78  WholeArrayIn splitTreeSupernodes, // (input)
79  WholeArrayOut joinSuperparent, // (output)
80  WholeArrayOut splitSuperparent, // (output)
81  WholeArrayOut newJoinID, // (output)
82  WholeArrayOut newSplitID); // (output)
83  typedef void ExecutionSignature(_1, InputIndex, _2, _3, _4, _5, _6, _7, _8, _9);
84  using InputDomain = _1;
85 
86  // Default Constructor
89 
90  template <typename InFieldPortalType, typename OutFieldPortalType>
91  VTKM_EXEC void operator()(const vtkm::Id& nodeID,
92  const vtkm::Id supernode,
93  const InFieldPortalType& joinTreeSuperparentsPortal,
94  const InFieldPortalType& splitTreeSuperparentsPortal,
95  const InFieldPortalType& joinTreeSupernodesPortal,
96  const InFieldPortalType& splitTreeSupernodesPortal,
97  const OutFieldPortalType& joinSuperparentPortal,
98  const OutFieldPortalType& splitSuperparentPortal,
99  const OutFieldPortalType& newJoinIDPortal,
100  const OutFieldPortalType& newSplitIDPortal) const
101  {
102  // Transfer the join information
103  // look up the join superparent in the join tree
104  vtkm::Id joinSuperparent = joinTreeSuperparentsPortal.Get(nodeID);
105  // save the join superparent
106  joinSuperparentPortal.Set(supernode, joinSuperparent);
107  // now, if the join superparent's mesh ID is the node itself, we're at a join supernode
108  if (joinTreeSupernodesPortal.Get(joinSuperparent) == nodeID)
109  newJoinIDPortal.Set(joinSuperparent, supernode);
110 
111  // Transfer the split information
112  // look up the split superparent in the split tree
113  vtkm::Id splitSuperparent = splitTreeSuperparentsPortal.Get(nodeID);
114  // save the split superparent
115  splitSuperparentPortal.Set(supernode, splitSuperparent);
116  // now, if the split superparent's mesh ID is the node, we're at a split supernode
117  if (splitTreeSupernodesPortal.Get(splitSuperparent) == nodeID)
118  newSplitIDPortal.Set(splitSuperparent, supernode);
119 
120  // In serial this worklet implements the following operation
121  /*
122  for (vtkm::Id supernode = 0; supernode < nSupernodes; supernode++)
123  { // per supernode
124 
125  // find the regular ID for the supernode
126  vtkm::Id nodeID = contourTree.Supernodes[supernode];
127 
128  // Transfer the join information
129  // look up the join superparent in the join tree
130  vtkm::Id joinSuperparent = joinTree.superparents[nodeID];
131  // save the join superparent
132  joinSuperparents[supernode] = joinSuperparent;
133  // now, if the join superparent's mesh ID is the node itself, we're at a join supernode
134  if (joinTree.Supernodes[joinSuperparent] == nodeID)
135  newJoinID[joinSuperparent] = supernode;
136 
137  // Transfer the split information
138  // look up the split superparent in the split tree
139  vtkm::Id splitSuperparent = splitTree.superparents[nodeID];
140  // save the split superparent
141  splitSuperparents[supernode] = splitSuperparent;
142  // now, if the split superparent's mesh ID is the node, we're at a split supernode
143  if (splitTree.Supernodes[splitSuperparent] == nodeID)
144  newSplitID[splitSuperparent] = supernode;
145 
146  } // per supernode
147  */
148  }
149 
150 }; // AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h
151 
152 } // namespace contourtree_maker_inc
153 } // namespace contourtree_augmented
154 } // namespace worklet
155 } // namespace vtkm
156 
157 #endif
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::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents
VTKM_EXEC_CONT AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents()
Definition: AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h:88
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
Types.h
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents::InputDomain
_1 InputDomain
Definition: AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h:84
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents
Definition: AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h:70
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents::ControlSignature
void ControlSignature(FieldIn contourTreeSupernodes, WholeArrayIn joinTreeSuperparents, WholeArrayIn splitTreeSuperparents, WholeArrayIn joinTreeSupernodes, WholeArrayIn splitTreeSupernodes, WholeArrayOut joinSuperparent, WholeArrayOut splitSuperparent, WholeArrayOut newJoinID, WholeArrayOut newSplitID)
Definition: AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h:73
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents::operator()
VTKM_EXEC void operator()(const vtkm::Id &nodeID, const vtkm::Id supernode, const InFieldPortalType &joinTreeSuperparentsPortal, const InFieldPortalType &splitTreeSuperparentsPortal, const InFieldPortalType &joinTreeSupernodesPortal, const InFieldPortalType &splitTreeSupernodesPortal, const OutFieldPortalType &joinSuperparentPortal, const OutFieldPortalType &splitSuperparentPortal, const OutFieldPortalType &newJoinIDPortal, const OutFieldPortalType &newSplitIDPortal) const
Definition: AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h:91
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents::ExecutionSignature
void ExecutionSignature(_1, InputIndex, _2, _3, _4, _5, _6, _7, _8, _9)
Definition: AugmentMergeTrees_InitNewJoinSplitIDAndSuperparents.h:83
vtkm::exec::arg::InputIndex
The ExecutionSignature tag to use to get the input index.
Definition: InputIndex.h:42
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38