VTK-m  2.0
TransferWeightsUpdateRHEWorklet.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_hyper_sweeper_transfer_weights_update_rhe_worklet_h
54 #define vtk_m_worklet_contourtree_distributed_hierarchical_hyper_sweeper_transfer_weights_update_rhe_worklet_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_distributed
64 {
65 namespace hierarchical_hyper_sweeper
66 {
67 
72 {
73 public:
74  using ControlSignature =
75  void(FieldIn supernodeIndex, // input counting array [firstSupernode, lastSupernode)
76  WholeArrayIn sortedTransferTarget,
77  FieldIn valuePrefixSumView, // input view of valuePrefixSum[firstSupernode, lastSupernode)
78  WholeArrayInOut dependentValuesPortal);
79  using ExecutionSignature = void(_1, _2, _3, _4);
80 
81  // Default Constructor
84  : LastSupernode(lastSupernode)
85  {
86  }
87 
88  template <typename InPortalType, typename OutPortalType>
89  VTKM_EXEC void operator()(const vtkm::Id& supernode,
90  const InPortalType& sortedTransferTargetPortal,
91  const vtkm::Id& valuePrefixSum, // same as valuePrefixSum[supernode]
92  OutPortalType& dependentValuesPortal) const
93  {
94  // per supernode
95  // ignore any that point at NO_SUCH_ELEMENT
96  vtkm::Id transferTarget = sortedTransferTargetPortal.Get(supernode);
98  {
99  // the RHE of each segment transfers its weight (including all irrelevant prefixes)
100  if ((supernode == this->LastSupernode - 1) ||
101  (transferTarget != sortedTransferTargetPortal.Get(supernode + 1)))
102  { // RHE of segment
103  auto originalValue = dependentValuesPortal.Get(transferTarget);
104  dependentValuesPortal.Set(transferTarget, originalValue + valuePrefixSum);
105  } // RHE of segment
106  }
107 
108  // In serial this worklet implements the following operation
109  /*
110  for (vtkm::Id supernode = firstSupernode; supernode < lastSupernode; supernode++)
111  { // per supernode
112  // ignore any that point at NO_SUCH_ELEMENT
113  if (noSuchElement(sortedTransferTarget[supernode]))
114  continue;
115 
116  // the RHE of each segment transfers its weight (including all irrelevant prefixes)
117  if ((supernode == lastSupernode - 1) || (sortedTransferTarget[supernode] != sortedTransferTarget[supernode+1]))
118  { // RHE of segment
119  dependentValues[sortedTransferTarget[supernode]] += valuePrefixSum[supernode];
120  } // RHE of segment
121  } // per supernode
122  */
123  } // operator()()
124 
125 private:
127 
128 }; // TransferWeightsUpdateRHEWorklet
129 
130 } // namespace hierarchical_hyper_sweeper
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
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::contourtree_distributed::hierarchical_hyper_sweeper::TransferWeightsUpdateRHEWorklet::TransferWeightsUpdateRHEWorklet
VTKM_EXEC_CONT TransferWeightsUpdateRHEWorklet(const vtkm::Id &lastSupernode)
Definition: TransferWeightsUpdateRHEWorklet.h:83
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::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::worklet::contourtree_distributed::hierarchical_hyper_sweeper::TransferWeightsUpdateRHEWorklet::ExecutionSignature
void(_1, _2, _3, _4) ExecutionSignature
Definition: TransferWeightsUpdateRHEWorklet.h:79
Types.h
vtkm::worklet::contourtree_distributed::hierarchical_hyper_sweeper::TransferWeightsUpdateRHEWorklet
Worklet used in HierarchicalHyperSweeper.TransferWeights(...) to implement step 7a.
Definition: TransferWeightsUpdateRHEWorklet.h:71
vtkm::worklet::contourtree_distributed::hierarchical_hyper_sweeper::TransferWeightsUpdateRHEWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &supernode, const InPortalType &sortedTransferTargetPortal, const vtkm::Id &valuePrefixSum, OutPortalType &dependentValuesPortal) const
Definition: TransferWeightsUpdateRHEWorklet.h:89
vtkm::worklet::contourtree_distributed::hierarchical_hyper_sweeper::TransferWeightsUpdateRHEWorklet::ControlSignature
void(FieldIn supernodeIndex, WholeArrayIn sortedTransferTarget, FieldIn valuePrefixSumView, WholeArrayInOut dependentValuesPortal) ControlSignature
Definition: TransferWeightsUpdateRHEWorklet.h:78
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38
vtkm::worklet::contourtree_distributed::hierarchical_hyper_sweeper::TransferWeightsUpdateRHEWorklet::LastSupernode
const vtkm::Id LastSupernode
Definition: TransferWeightsUpdateRHEWorklet.h:126