VTK-m  2.0
CompressRegularisedNodesResolveRootWorklet.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_compress_regularised_nodes_resolve_root_worklet_h
54 #define vtk_m_worklet_contourtree_distributed_bract_maker_compress_regularised_nodes_resolve_root_worklet_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_distributed
64 {
65 namespace bract_maker
66 {
67 
70 {
71 public:
72  using ControlSignature = void(FieldIn newIndex, // input
73  WholeArrayInOut newSuperarc // input/output
74  );
75  using ExecutionSignature = void(_1, _2);
76  using InputDomain = _1;
77 
78  // Default Constructor
81 
82  template <typename InOutFieldPortalType>
83  VTKM_EXEC void operator()(const vtkm::Id& newIndex,
84  const InOutFieldPortalType& newSuperarcPortal) const
85  {
86  // per kept vertex
87  // retrieve it to register
88  vtkm::Id newInbound = newSuperarcPortal.Get(newIndex);
89 
90  // if it doesn't exist, do nothing
92  {
93  return;
94  }
95 
96  // if there is no loopback, do nothing
97  if (newSuperarcPortal.Get(newInbound) != newIndex)
98  {
99  return;
100  }
101 
102  // if there is loopback and we're the lower one, substitute NULL
103  if (newIndex < newInbound)
104  {
105  newSuperarcPortal.Set(newIndex,
107  }
108 
109  // In serial this worklet implements the following operation
110  /*
111  for (indexType newIndex = 0; newIndex < nKept; newIndex++)
112  { // per kept vertex
113  // retrieve it to register
114  indexType newInbound = newSuperarc[newIndex];
115 
116  // if it doesn't exist, do nothing
117  if (noSuchElement(newInbound))
118  continue;
119 
120  // if there is no loopback, do nothing
121  if (newSuperarc[newInbound] != newIndex)
122  continue;
123 
124  // if there is loopback and we're the lower one, substitute NULL
125  if (newIndex < newInbound)
126  newSuperarc[newIndex] = NO_SUCH_ELEMENT;
127  } // per kept vertex
128  */
129  }
130 }; // CompressRegularisedNodesResolveRootWorklet
131 
132 
133 } // namespace bract_maker
134 } // namespace contourtree_distributed
135 } // namespace worklet
136 } // namespace vtkm
137 
138 #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::CompressRegularisedNodesResolveRootWorklet
Step 1 of IdentifyRegularisedSupernodes.
Definition: CompressRegularisedNodesResolveRootWorklet.h:69
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::bract_maker::CompressRegularisedNodesResolveRootWorklet::ControlSignature
void(FieldIn newIndex, WholeArrayInOut newSuperarc) ControlSignature
Definition: CompressRegularisedNodesResolveRootWorklet.h:74
vtkm::worklet::contourtree_distributed::bract_maker::CompressRegularisedNodesResolveRootWorklet::ExecutionSignature
void(_1, _2) ExecutionSignature
Definition: CompressRegularisedNodesResolveRootWorklet.h:75
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
Types.h
vtkm::worklet::contourtree_distributed::bract_maker::CompressRegularisedNodesResolveRootWorklet::InputDomain
_1 InputDomain
Definition: CompressRegularisedNodesResolveRootWorklet.h:76
vtkm::worklet::contourtree_distributed::bract_maker::CompressRegularisedNodesResolveRootWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &newIndex, const InOutFieldPortalType &newSuperarcPortal) const
Definition: CompressRegularisedNodesResolveRootWorklet.h:83
vtkm::worklet::contourtree_distributed::bract_maker::CompressRegularisedNodesResolveRootWorklet::CompressRegularisedNodesResolveRootWorklet
VTKM_EXEC_CONT CompressRegularisedNodesResolveRootWorklet()
Definition: CompressRegularisedNodesResolveRootWorklet.h:80
vtkm::worklet::contourtree_augmented::NO_SUCH_ELEMENT
constexpr vtkm::Id NO_SUCH_ELEMENT
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:73
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38