VTK-m  2.0
DegreeDelta.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) 2016, Los Alamos National Security, LLC
11 // All rights reserved.
12 //
13 // Copyright 2016. Los Alamos National Security, LLC.
14 // This software was produced under U.S. Government contract DE-AC52-06NA25396
15 // for Los Alamos National Laboratory (LANL), which is operated by
16 // Los Alamos National Security, LLC for the U.S. Department of Energy.
17 // The U.S. Government has rights to use, reproduce, and distribute this
18 // software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC
19 // MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE
20 // USE OF THIS SOFTWARE. If software is modified to produce derivative works,
21 // such modified software should be clearly marked, so as not to confuse it
22 // with the version available from LANL.
23 //
24 // Additionally, redistribution and use in source and binary forms, with or
25 // without modification, are permitted provided that the following conditions
26 // are met:
27 //
28 // 1. Redistributions of source code must retain the above copyright notice,
29 // this list of conditions and the following disclaimer.
30 // 2. Redistributions in binary form must reproduce the above copyright notice,
31 // this list of conditions and the following disclaimer in the documentation
32 // and/or other materials provided with the distribution.
33 // 3. Neither the name of Los Alamos National Security, LLC, Los Alamos
34 // National Laboratory, LANL, the U.S. Government, nor the names of its
35 // contributors may be used to endorse or promote products derived from
36 // this software without specific prior written permission.
37 //
38 // THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND
39 // CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
40 // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
41 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS
42 // NATIONAL SECURITY, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
43 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
44 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
45 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
46 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
47 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
48 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49 //============================================================================
50 
51 // This code is based on the algorithm presented in the paper:
52 // “Parallel Peak Pruning for Scalable SMP Contour Tree Computation.”
53 // Hamish Carr, Gunther Weber, Christopher Sewell, and James Ahrens.
54 // Proceedings of the IEEE Symposium on Large Data Analysis and Visualization
55 // (LDAV), October 2016, Baltimore, Maryland.
56 
57 #ifndef vtkm_worklet_contourtree_degree_delta_h
58 #define vtkm_worklet_contourtree_degree_delta_h
59 
61 
62 namespace vtkm
63 {
64 namespace worklet
65 {
66 namespace contourtree
67 {
68 
69 // Worklet for doing regular to candidate
71 {
72 public:
73  using ControlSignature = void(FieldIn sortID, // (input) index into sorted vertices [1..N]
74  WholeArrayIn sortVector, // (input) sorted vector of vertices
75  WholeArrayOut candidate); // (output) candidate
76  using ExecutionSignature = void(_1, _2, _3);
77  using InputDomain = _1;
78 
80 
81  // Constructor
83  DegreeDelta(vtkm::Id NCandidates)
84  : nCandidates(NCandidates)
85  {
86  }
87 
88  template <typename InFieldPortalType, typename OutFieldPortalType>
89  VTKM_EXEC void operator()(const vtkm::Id& sortID,
90  const InFieldPortalType& sortVector,
91  const OutFieldPortalType& candidate) const
92  {
93  vtkm::Id iCandidate = sortVector.Get(sortID);
94  // last element needs to be subtracted from vector size
95  if (sortID == nCandidates - 1)
96  { // final element
97  candidate.Set(iCandidate, (nCandidates - candidate.Get(iCandidate)));
98  } // final element
99  // otherwise, if the next one is different
100  else
101  { // not the last element
102  vtkm::Id nextCandidate = sortVector.Get(sortID + 1);
103  if (iCandidate != nextCandidate)
104  { // no match
105  candidate.Set(iCandidate, (sortID + 1 - candidate.Get(iCandidate)));
106  } // no match
107  } // not the last element
108  }
109 }; // DegreeDelta
110 }
111 }
112 }
113 
114 #endif
vtkm::worklet::contourtree::DegreeDelta::operator()
VTKM_EXEC void operator()(const vtkm::Id &sortID, const InFieldPortalType &sortVector, const OutFieldPortalType &candidate) const
Definition: DegreeDelta.h:89
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::DegreeDelta::ControlSignature
void(FieldIn sortID, WholeArrayIn sortVector, WholeArrayOut candidate) ControlSignature
Definition: DegreeDelta.h:75
vtkm::worklet::contourtree::DegreeDelta
Definition: DegreeDelta.h:70
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree::DegreeDelta::ExecutionSignature
void(_1, _2, _3) ExecutionSignature
Definition: DegreeDelta.h:76
vtkm::worklet::contourtree::DegreeDelta::InputDomain
_1 InputDomain
Definition: DegreeDelta.h:77
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::worklet::contourtree::DegreeDelta::nCandidates
vtkm::Id nCandidates
Definition: DegreeDelta.h:79
vtkm::worklet::contourtree::DegreeDelta::DegreeDelta
VTKM_EXEC_CONT DegreeDelta(vtkm::Id NCandidates)
Definition: DegreeDelta.h:83
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38