VTK-m  2.0
InitalizeSuperchildrenWorklet.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_distributed_hierarchical_contour_tree_initialize_superchildren_worklet_h
54 #define vtk_m_worklet_contourtree_distributed_hierarchical_contour_tree_initialize_superchildren_worklet_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_distributed
64 {
65 
68 {
69 public:
70  using ControlSignature = void(FieldIn hyperarcs, // input
71  WholeArrayIn hypernodes, // input
72  FieldOut superchildren // output
73  );
74  using ExecutionSignature = _3(InputIndex, _1, _2);
75  using InputDomain = _1;
76 
77  // Default Constructor
80 
81  template <typename InFieldPortalType>
83  const vtkm::Id& hyperarcVal,
84  const InFieldPortalType& hypernodesPortal) const
85  {
86  // per hyperarc
87  // test for root element
89  {
90  // root has one superchild: the root supernode
91  return static_cast<vtkm::Id>(1);
92  }
93  else
94  {
95  // otherwise, compute a delta
96  return hypernodesPortal.Get(hyperarc + 1) - hypernodesPortal.Get(hyperarc);
97  }
98 
99  // In serial this worklet implements the following operation
100  /*
101  for (indexType hyperarc = 0; hyperarc < hyperarcs.size(); hyperarc++)
102  { // per hyperarc
103  // test for root element
104  if (noSuchElement(hyperarcs[hyperarc]))
105  // root has one superchild: the root supernode
106  superchildren[hyperarc] = 1;
107  else
108  // otherwise, compute a delta
109  superchildren[hyperarc] = hypernodes[hyperarc+1] - hypernodes[hyperarc];
110  } // per hyperarc
111  */
112  } // operator()()
113 
114 }; // InitalizeSuperchildrenWorklet
115 
116 
117 } // namespace contourtree_distributed
118 } // namespace worklet
119 } // namespace vtkm
120 
121 #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::InitalizeSuperchildrenWorklet::ControlSignature
void(FieldIn hyperarcs, WholeArrayIn hypernodes, FieldOut superchildren) ControlSignature
Definition: InitalizeSuperchildrenWorklet.h:73
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::WorkletMapField::FieldOut
A control signature tag for output fields.
Definition: WorkletMapField.h:60
vtkm::worklet::contourtree_distributed::InitalizeSuperchildrenWorklet::ExecutionSignature
_3(InputIndex, _1, _2) ExecutionSignature
Definition: InitalizeSuperchildrenWorklet.h:74
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_distributed::InitalizeSuperchildrenWorklet::InputDomain
_1 InputDomain
Definition: InitalizeSuperchildrenWorklet.h:75
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
Types.h
vtkm::worklet::contourtree_distributed::InitalizeSuperchildrenWorklet::InitalizeSuperchildrenWorklet
VTKM_EXEC_CONT InitalizeSuperchildrenWorklet()
Definition: InitalizeSuperchildrenWorklet.h:79
vtkm::worklet::contourtree_distributed::InitalizeSuperchildrenWorklet
Compute the superarc "to" for every boundary tree node.
Definition: InitalizeSuperchildrenWorklet.h:67
vtkm::worklet::contourtree_distributed::InitalizeSuperchildrenWorklet::operator()
VTKM_EXEC vtkm::Id operator()(const vtkm::Id &hyperarc, const vtkm::Id &hyperarcVal, const InFieldPortalType &hypernodesPortal) const
Definition: InitalizeSuperchildrenWorklet.h:82
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