VTK-m  2.0
RegularPointTransferrer.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 // This functor replaces a parallel loop through regular points, since more than one
62 // output needs to be set.
63 //
64 // Any vector needed by the functor for lookup purposes will be passed as a parameter to
65 // the constructor and saved, with the actual function call being the operator ()
66 //
67 // Vectors marked I/O are intrinsically risky unless there is an algorithmic guarantee
68 // that the read/writes are completely independent - which for our case actually occurs
69 // The I/O vectors should therefore be justified in comments both here & in caller
70 //
71 //=======================================================================================
72 
73 #ifndef vtkm_worklet_contourtree_regular_point_transferrer_h
74 #define vtkm_worklet_contourtree_regular_point_transferrer_h
75 
80 
81 namespace vtkm
82 {
83 namespace worklet
84 {
85 namespace contourtree
86 {
87 
88 // Worklet for setting initial chain maximum value
89 template <typename T>
91 {
92 public:
94 
95  using ControlSignature = void(FieldIn vertexID, // (input) vertex ID
96  WholeArrayIn chainExtremum, // (input) chain extremum
97  WholeArrayIn values, // (input) values array
98  WholeArrayIn valueIndex, // (input) index into value array
99  WholeArrayInOut prunesTo, // (i/o) where vertex is pruned to
100  WholeArrayOut outdegree); // (output) updegree of vertex
101  using ExecutionSignature = void(_1, _2, _3, _4, _5, _6);
102  using InputDomain = _1;
103 
105 
106  // Constructor
108  RegularPointTransferrer(bool IsJoinGraph)
109  : isJoinGraph(IsJoinGraph)
110  {
111  }
112 
113  template <typename InFieldPortalType,
114  typename InIndexPortalType,
115  typename InOutFieldPortalType,
116  typename OutFieldPortalType>
117  VTKM_EXEC void operator()(const vtkm::Id& vertexID,
118  const InIndexPortalType& chainExtremum,
119  const InFieldPortalType& values,
120  const InIndexPortalType& valueIndex,
121  const InOutFieldPortalType& prunesTo,
122  const OutFieldPortalType& outdegree) const
123  {
125 
126  // ignore vertices which have already been labelled
127  vtkm::Id saddleID = prunesTo.Get(vertexID);
128 
129  if (saddleID != NO_VERTEX_ASSIGNED)
130  return;
131 
132  // now, if the vertex is beyond the governing saddle, we need to label it
133  // and arrange to get rid of it
134  saddleID = prunesTo.Get(chainExtremum.Get(vertexID));
135 
136  if (lessThan(valueIndex.Get(saddleID), valueIndex.Get(vertexID), !isJoinGraph))
137  {
138  // set the merge extremum to the current chain extremum
139  prunesTo.Set(vertexID, chainExtremum.Get(vertexID));
140  // and reset the outdegree to zero
141  outdegree.Set(vertexID, 0);
142  } // regular point to be pruned
143  }
144 }; // RegularPointTransferrer
145 }
146 }
147 }
148 
149 #endif
vtkm::worklet::contourtree::RegularPointTransferrer::isJoinGraph
bool isJoinGraph
Definition: RegularPointTransferrer.h:104
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
Mesh2D_DEM_Triangulation_Macros.h
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::contourtree::RegularPointTransferrer::ControlSignature
void(FieldIn vertexID, WholeArrayIn chainExtremum, WholeArrayIn values, WholeArrayIn valueIndex, WholeArrayInOut prunesTo, WholeArrayOut outdegree) ControlSignature
Definition: RegularPointTransferrer.h:100
vtkm::worklet::contourtree::RegularPointTransferrer::ExecutionSignature
void(_1, _2, _3, _4, _5, _6) ExecutionSignature
Definition: RegularPointTransferrer.h:101
VertexValueComparator.h
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree::RegularPointTransferrer::RegularPointTransferrer
VTKM_EXEC_CONT RegularPointTransferrer(bool IsJoinGraph)
Definition: RegularPointTransferrer.h:108
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
NO_VERTEX_ASSIGNED
#define NO_VERTEX_ASSIGNED
Definition: filter/scalar_topology/worklet/contourtree/Types.h:77
vtkm::worklet::contourtree::RegularPointTransferrer::operator()
VTKM_EXEC void operator()(const vtkm::Id &vertexID, const InIndexPortalType &chainExtremum, const InFieldPortalType &values, const InIndexPortalType &valueIndex, const InOutFieldPortalType &prunesTo, const OutFieldPortalType &outdegree) const
Definition: RegularPointTransferrer.h:117
vtkm::worklet::contourtree::RegularPointTransferrer::InputDomain
_1 InputDomain
Definition: RegularPointTransferrer.h:102
vtkm::worklet::contourtree::VertexValueComparator
Definition: VertexValueComparator.h:83
vtkm::List
Definition: List.h:34
Types.h
vtkm::worklet::contourtree::RegularPointTransferrer
Definition: RegularPointTransferrer.h:90
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38