VTK-m  2.0
meshextrema/PointerDoubling.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_augmented_pointer_doubling_h
54 #define vtk_m_worklet_contourtree_augmented_pointer_doubling_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_augmented
64 {
65 namespace mesh_extrema_inc
66 {
67 
68 // Functor for doing chain doubling
69 // Unary because it takes the index of the element to process, and is not guaranteed to
70 // write back moreover, we aren't worried about out-of-sequence writes, since the
71 // worst that happens is that an element gets pointer-tripled in the iteration.
72 // It will still converge to the same destination.
74 {
75 public:
76  typedef void ControlSignature(FieldIn vertexID, WholeArrayInOut chains);
77  typedef void ExecutionSignature(_1, _2);
78  using InputDomain = _1;
79 
80  // Constructor
83 
84  template <typename InOutFieldPortalType>
85  VTKM_EXEC void operator()(const vtkm::Id& vertexID, const InOutFieldPortalType& chains) const
86  {
87  // get the neighbour's ID
88  vtkm::Id neighbour = chains.Get(vertexID);
89  // if this is not a terminal vertex
90  if (!IsTerminalElement(neighbour))
91  {
92  // then double-step
93  chains.Set(vertexID, chains.Get(neighbour));
94  } // else, if the vertex is terminal then do nothing
95  }
96 }; // PointerDoubling
97 
98 } // namespace mesh_extrema_inc
99 } // namespace contourtree_augmented
100 } // namespace worklet
101 } // namespace vtkm
102 
103 #endif // vtkm_worklet_contourtree_augmented_pointer_doubling_h
vtkm::worklet::contourtree_augmented::mesh_extrema_inc::PointerDoubling::operator()
VTKM_EXEC void operator()(const vtkm::Id &vertexID, const InOutFieldPortalType &chains) const
Definition: meshextrema/PointerDoubling.h:85
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm::worklet::contourtree_augmented::IsTerminalElement
VTKM_EXEC_CONT bool IsTerminalElement(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:103
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::mesh_extrema_inc::PointerDoubling::ControlSignature
void ControlSignature(FieldIn vertexID, WholeArrayInOut chains)
Definition: meshextrema/PointerDoubling.h:76
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree_augmented::mesh_extrema_inc::PointerDoubling
Definition: meshextrema/PointerDoubling.h:73
vtkm::worklet::contourtree_augmented::mesh_extrema_inc::PointerDoubling::PointerDoubling
VTKM_EXEC_CONT PointerDoubling()
Definition: meshextrema/PointerDoubling.h:82
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
Types.h
vtkm::worklet::contourtree_augmented::mesh_extrema_inc::PointerDoubling::InputDomain
_1 InputDomain
Definition: meshextrema/PointerDoubling.h:78
vtkm::worklet::contourtree_augmented::mesh_extrema_inc::PointerDoubling::ExecutionSignature
void ExecutionSignature(_1, _2)
Definition: meshextrema/PointerDoubling.h:77
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38