VTK-m  2.0
SaddleAscentTransferrer.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 //=======================================================================================
58 //
59 // COMMENTS:
60 //
61 // Any vector needed by the functor for lookup purposes will be passed as a parameter to
62 // the constructor and saved, with the actual function call being the operator ()
63 //
64 // Vectors marked I/O are intrinsically risky unless there is an algorithmic guarantee
65 // that the read/writes are completely independent - which for our case actually occurs
66 // The I/O vectors should therefore be justified in comments both here & in caller
67 //
68 //=======================================================================================
69 
70 #ifndef vtkm_worklet_contourtree_saddle_ascent_transferrer_h
71 #define vtkm_worklet_contourtree_saddle_ascent_transferrer_h
72 
74 
75 namespace vtkm
76 {
77 namespace worklet
78 {
79 namespace contourtree
80 {
81 
82 // Worklet for setting initial chain maximum value
84 {
85 public:
86  using ControlSignature = void(FieldIn vertexID, // (input) active vertex
87  FieldIn newOutdegree, // (input) updated updegree
88  FieldIn newFirstEdge, // (input) updated first edge of vertex
89  WholeArrayIn activeEdges, // (input) active edges
90  WholeArrayIn firstEdge, // (input) first edges
91  WholeArrayOut edgeSorter); // (output) edge sorter
92  using ExecutionSignature = void(_1, _2, _3, _4, _5, _6);
93  using InputDomain = _1;
94 
95  // Constructor
98 
99  template <typename InFieldPortalType, typename OutFieldPortalType>
100  VTKM_EXEC void operator()(const vtkm::Id& vertexID,
101  const vtkm::Id& newOutdegree,
102  const vtkm::Id& newFirstEdge,
103  const InFieldPortalType& activeEdges,
104  const InFieldPortalType& firstEdge,
105  const OutFieldPortalType& edgeSorter) const
106  {
107  // loop through the edges from the vertex
108  for (vtkm::Id edge = 0; edge < newOutdegree; edge++)
109  {
110  // compute which index in the new sorting array
111  vtkm::Id edgeSorterIndex = newFirstEdge + edge;
112  // now retrieve the old edge
113  vtkm::Id edgeID = activeEdges.Get(firstEdge.Get(vertexID) + edge);
114  // adding them to the edge sort array
115  edgeSorter.Set(edgeSorterIndex, edgeID);
116  }
117  }
118 
119 }; // SaddleAscentTransferrer
120 }
121 }
122 }
123 
124 #endif
vtkm::worklet::contourtree::SaddleAscentTransferrer
Definition: SaddleAscentTransferrer.h:83
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::SaddleAscentTransferrer::InputDomain
_1 InputDomain
Definition: SaddleAscentTransferrer.h:93
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree::SaddleAscentTransferrer::ExecutionSignature
void(_1, _2, _3, _4, _5, _6) ExecutionSignature
Definition: SaddleAscentTransferrer.h:92
vtkm::worklet::contourtree::SaddleAscentTransferrer::operator()
VTKM_EXEC void operator()(const vtkm::Id &vertexID, const vtkm::Id &newOutdegree, const vtkm::Id &newFirstEdge, const InFieldPortalType &activeEdges, const InFieldPortalType &firstEdge, const OutFieldPortalType &edgeSorter) const
Definition: SaddleAscentTransferrer.h:100
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::worklet::contourtree::SaddleAscentTransferrer::SaddleAscentTransferrer
VTKM_EXEC_CONT SaddleAscentTransferrer()
Definition: SaddleAscentTransferrer.h:97
vtkm::worklet::contourtree::SaddleAscentTransferrer::ControlSignature
void(FieldIn vertexID, FieldIn newOutdegree, FieldIn newFirstEdge, WholeArrayIn activeEdges, WholeArrayIn firstEdge, WholeArrayOut edgeSorter) ControlSignature
Definition: SaddleAscentTransferrer.h:91
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38