VTK-m  2.0
PropagateBoundaryCountsTransferDependentCountsWorklet.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_bract_maker_propagate_boundary_counts_transfer_dependent_counts_worklet_h
54 #define vtk_m_worklet_contourtree_distributed_bract_maker_propagate_boundary_counts_transfer_dependent_counts_worklet_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_distributed
64 {
65 namespace bract_maker
66 {
67 
71 {
72 public:
73  using ControlSignature = void(FieldIn supernodeIndex, // (input) index of supernodes for iteration
74  WholeArrayIn hypernodes, // (input) contour tree hypernodes
75  WholeArrayIn superarcDependentBoundaryCount, // (input)
76  WholeArrayOut hyperarcDependentBoundaryCount // (output)
77  );
78  using ExecutionSignature = void(_1, _2, _3, _4);
79  using InputDomain = _1;
80 
81  // Default Constructor
84  vtkm::Id numHypernodes)
85  : NumSupernodes(numSupernodes)
86  , NumHypernodes(numHypernodes)
87  {
88  }
89 
90  template <typename InFieldPortalType, typename OutFieldPortalType>
91  VTKM_EXEC void operator()(const vtkm::Id& hypernode,
92  const InFieldPortalType& hypernodesPortal,
93  const InFieldPortalType& superarcDependentBoundaryCountPortal,
94  const OutFieldPortalType& hyperarcDependentBoundaryCountPortal) const
95  {
96  // v. per hypernode
97  // A.Transfer dependent count from last superarc to hyperarc
98  // Last superarc for the hyperarc
99  vtkm::Id lastSuperarc;
100  // special case for the last hyperarc
101  if (hypernode == this->NumHypernodes - 1)
102  {
103  lastSuperarc = this->NumSupernodes - 1;
104  }
105  else
106  {
107  lastSuperarc =
108  vtkm::worklet::contourtree_augmented::MaskedIndex(hypernodesPortal.Get(hypernode + 1)) - 1;
109  }
110  // Transfer the dependent count
111  hyperarcDependentBoundaryCountPortal.Set(
112  hypernode, superarcDependentBoundaryCountPortal.Get(lastSuperarc));
113 
114  // In serial this worklet implements the following operation
115  /*
116  for (vtkm::Id hypernode = firstHypernode; hypernode < lastHypernode; hypernode++)
117  { // v. per hypernode
118  // A. Transfer dependent count from last superarc to hyperarc
119  // Last superarc for the hyperarc
120  vtkm::Id lastSuperarc;
121  // special case for the last hyperarc
122  if (hypernode == contourTree->hypernodes.size() - 1)
123  lastSuperarc = contourTree->supernodes.size() - 1;
124  else
125  lastSuperarc = maskedIndex(contourTree->hypernodes[hypernode + 1]) - 1;
126 
127  // Transfer the dependent count
128  hyperarcDependentBoundaryCount[hypernode] = superarcDependentBoundaryCount[lastSuperarc];
129  */
130  }
131 
132 private:
135 
136 }; // PropagateBoundaryCountsTransferDependentCountsWorklet
137 
138 
139 } // namespace bract_maker
140 } // namespace contourtree_distributed
141 } // namespace worklet
142 } // namespace vtkm
143 
144 #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::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::NumHypernodes
vtkm::Id NumHypernodes
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:134
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
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::PropagateBoundaryCountsTransferDependentCountsWorklet
VTKM_EXEC_CONT PropagateBoundaryCountsTransferDependentCountsWorklet(vtkm::Id numSupernodes, vtkm::Id numHypernodes)
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:83
Types.h
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::NumSupernodes
vtkm::Id NumSupernodes
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:133
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::ControlSignature
void(FieldIn supernodeIndex, WholeArrayIn hypernodes, WholeArrayIn superarcDependentBoundaryCount, WholeArrayOut hyperarcDependentBoundaryCount) ControlSignature
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:77
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::InputDomain
_1 InputDomain
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:79
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet
Worklet to transfer the dependent counts for hyperarcs Part of the BoundaryRestrictedAugmentedContour...
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:70
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &hypernode, const InFieldPortalType &hypernodesPortal, const InFieldPortalType &superarcDependentBoundaryCountPortal, const OutFieldPortalType &hyperarcDependentBoundaryCountPortal) const
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:91
vtkm::worklet::contourtree_distributed::bract_maker::PropagateBoundaryCountsTransferDependentCountsWorklet::ExecutionSignature
void(_1, _2, _3, _4) ExecutionSignature
Definition: PropagateBoundaryCountsTransferDependentCountsWorklet.h:78
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38