VTK-m  2.0
ResizeArraysBuildNewSupernodeIdsWorklet.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 // The PPP2 algorithm and software were jointly developed by
42 // Hamish Carr (University of Leeds), Gunther H. Weber (LBNL), and
43 // Oliver Ruebel (LBNL)
44 //==============================================================================
45 
46 #ifndef vtk_m_worklet_contourtree_distributed_hierarchical_augmenter_resize_arrays_build_new_supernode_ids_worklet_h
47 #define vtk_m_worklet_contourtree_distributed_hierarchical_augmenter_resize_arrays_build_new_supernode_ids_worklet_h
48 
51 
52 namespace vtkm
53 {
54 namespace worklet
55 {
56 namespace contourtree_distributed
57 {
58 namespace hierarchical_augmenter
59 {
60 
63 {
64 public:
66  using ControlSignature = void(
67  FieldIn supernodeIndex, // input domain ArrayHandleIndex(SupernodeSorter.GetNumberOfValues())
68  FieldIn
69  supernodeIdSetPermuted, // input supernodeIDSet permuted by supernodeSorter to allow for FieldIn
70  WholeArrayInOut
71  newSupernodeIds // output/input (both are necessary since not all valyes will be overwritten)
72  );
73  using ExecutionSignature = void(_1, _2, _3);
74  using InputDomain = _1;
75 
76  // Default Constructor
79  : NumSupernodesAlready(numSupernodesAlready)
80  {
81  }
82 
83  template <typename InOutFieldPortalType>
85  const vtkm::Id& supernode, // InputIndex of supernodeSorter
86  const vtkm::Id& oldSupernodeId, // same as supernodeIDSet[supernodeSetIndex];
87  const InOutFieldPortalType& newSupernodeIdsPortal) const
88  {
89  // per supernode
90  // retrieve the index from the sorting index array. supernodeSetIndex set on input
91 
92  // work out the correct new supernode ID
93  vtkm::Id newSupernodeId = this->NumSupernodesAlready + supernode;
94 
95  // retrieve the old supernode ID from the sorting array, remembering
96  // that if it came from another block it will be set to NO_SUCH_ELEMENT
97  // vtkm::Id oldSupernodeId set on input since we use ArrayHandlePermutation to
98  // shuffle supernodeIDSet by supernodeSorter;
99 
100  // and write to the lookup array
102  {
103  newSupernodeIdsPortal.Set(oldSupernodeId, newSupernodeId);
104  }
105 
106  // In serial this worklet implements the following operation
107  /*
108  for (vtkm::Id supernode = 0; supernode < supernodeSorter.size(); supernode++)
109  { // per supernode
110  // retrieve the index from the sorting index array
111  vtkm::Id supernodeSetIndex = supernodeSorter[supernode];
112 
113  // work out the correct new supernode ID
114  vtkm::Id newSupernodeID = numSupernodesAlready + supernode;
115 
116  // retrieve the old supernode ID from the sorting array, remembering that if it came from another block it will be set to NO_SUCH_ELEMENT
117  vtkm::Id oldSupernodeID = supernodeIDSet[supernodeSetIndex];
118 
119  // and write to the lookup array
120  if (!noSuchElement(oldSupernodeID))
121  newSupernodeIDs[oldSupernodeID] = newSupernodeID;
122  } // per supernode
123  */
124  } // operator()()
125 private:
127 
128 }; // ResizeArraysBuildNewSupernodeIdsWorklet
129 
130 } // namespace hierarchical_augmenter
131 } // namespace contourtree_distributed
132 } // namespace worklet
133 } // namespace vtkm
134 
135 #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_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet
Worklet used in HierarchicalAugmenter<FieldType>ResizeArrays to build the newSupernodeIds array.
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:62
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet::InputDomain
_1 InputDomain
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:74
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &supernode, const vtkm::Id &oldSupernodeId, const InOutFieldPortalType &newSupernodeIdsPortal) const
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:84
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_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet::NumSupernodesAlready
const vtkm::Id NumSupernodesAlready
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:126
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
Types.h
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet::ControlSignature
void(FieldIn supernodeIndex, FieldIn supernodeIdSetPermuted, WholeArrayInOut newSupernodeIds) ControlSignature
Control signature for the worklet.
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:72
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet::ExecutionSignature
void(_1, _2, _3) ExecutionSignature
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:73
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::ResizeArraysBuildNewSupernodeIdsWorklet::ResizeArraysBuildNewSupernodeIdsWorklet
VTKM_EXEC_CONT ResizeArraysBuildNewSupernodeIdsWorklet(const vtkm::Id &numSupernodesAlready)
Definition: ResizeArraysBuildNewSupernodeIdsWorklet.h:78
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38