VTK-m  2.0
AddTerminalFlagsToUpDownNeighboursWorklet.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_add_terminal_flags_to_up_down_neighbours_worklet_h
54 #define vtk_m_worklet_contourtree_distributed_bract_maker_add_terminal_flags_to_up_down_neighbours_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 newVertexId, // input
73  WholeArrayOut upNeighbour, // output
74  WholeArrayOut downNeighbour // output
75  );
76  using ExecutionSignature = void(InputIndex, _1, _2, _3);
77  using InputDomain = _1;
78 
79  // Default Constructor
82 
83  template <typename OutFieldPortalType>
84  VTKM_EXEC void operator()(const vtkm::Id& returnIndex,
85  const vtkm::Id& newVertexIdValue,
86  const OutFieldPortalType& upNeighbourPortal,
87  const OutFieldPortalType& downNeighbourPortal) const
88  {
89  // per vertex
90  // necessary vertices
92  { // necessary vertex
93  // set both up & down neighbours to self with terminal element set
94  upNeighbourPortal.Set(returnIndex,
96  downNeighbourPortal.Set(returnIndex,
98  } // necessary vertex
99 
100  // In serial this worklet implements the following operation
101  /*
102  for (indexType returnIndex = 0; returnIndex < bractVertexSuperset.size(); returnIndex++)
103  { // per vertex
104  // necessary vertices
105  if (!noSuchElement(newVertexID[returnIndex]))
106  { // necessary vertex
107  // set both up & down neighbours to self with terminal element set
108  upNeighbour[returnIndex] = downNeighbour[returnIndex] = returnIndex | TERMINAL_ELEMENT;
109  } // necessary vertex
110  } // per vertex
111  */
112  }
113 }; // AddTerminalFlagsToUpDownNeighboursWorklet
114 
115 
116 } // namespace bract_maker
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
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::contourtree_augmented::TERMINAL_ELEMENT
constexpr vtkm::Id TERMINAL_ELEMENT
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:74
vtkm::worklet::contourtree_distributed::bract_maker::AddTerminalFlagsToUpDownNeighboursWorklet
Step 1 of IdentifyRegularisedSupernodes.
Definition: AddTerminalFlagsToUpDownNeighboursWorklet.h:69
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree_distributed::bract_maker::AddTerminalFlagsToUpDownNeighboursWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &returnIndex, const vtkm::Id &newVertexIdValue, const OutFieldPortalType &upNeighbourPortal, const OutFieldPortalType &downNeighbourPortal) const
Definition: AddTerminalFlagsToUpDownNeighboursWorklet.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::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::worklet::contourtree_distributed::bract_maker::AddTerminalFlagsToUpDownNeighboursWorklet::InputDomain
_1 InputDomain
Definition: AddTerminalFlagsToUpDownNeighboursWorklet.h:77
Types.h
vtkm::worklet::contourtree_distributed::bract_maker::AddTerminalFlagsToUpDownNeighboursWorklet::ControlSignature
void(FieldIn newVertexId, WholeArrayOut upNeighbour, WholeArrayOut downNeighbour) ControlSignature
Definition: AddTerminalFlagsToUpDownNeighboursWorklet.h:75
vtkm::worklet::contourtree_distributed::bract_maker::AddTerminalFlagsToUpDownNeighboursWorklet::AddTerminalFlagsToUpDownNeighboursWorklet
VTKM_EXEC_CONT AddTerminalFlagsToUpDownNeighboursWorklet()
Definition: AddTerminalFlagsToUpDownNeighboursWorklet.h:81
vtkm::worklet::contourtree_distributed::bract_maker::AddTerminalFlagsToUpDownNeighboursWorklet::ExecutionSignature
void(InputIndex, _1, _2, _3) ExecutionSignature
Definition: AddTerminalFlagsToUpDownNeighboursWorklet.h:76
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