VTK-m  2.0
AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.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_augment_boundary_with_necessary_interior_supernodes_append_necessary_supernodes_worklet_h
54 #define vtk_m_worklet_contourtree_distributed_bract_maker_augment_boundary_with_necessary_interior_supernodes_append_necessary_supernodes_worklet_h
55 
58 
59 namespace vtkm
60 {
61 namespace worklet
62 {
63 namespace contourtree_distributed
64 {
65 namespace bract_maker
66 {
67 
72 {
73 public:
74  using ControlSignature = void(FieldIn supernodes, // input
75  FieldIn isNecessaryAndInterior, // input
76  FieldIn boundaryNecessaryId, // input
77  WholeArrayIn meshSortOrder, // input
78  WholeArrayOut boundaryIndices, //output
79  WholeArrayOut bractVertexSuperset // output
80  );
81  using ExecutionSignature = void(_1, _2, _3, _4, _5, _6);
82  using InputDomain = _1;
83 
84  // Default Constructor
87  vtkm::Id numBoundary)
88  : NumBoundary(numBoundary)
89  {
90  }
91 
92  template <typename InFieldPortalType, typename OutFieldPortalType>
93  VTKM_EXEC void operator()(const vtkm::Id& supernode,
94  const bool& isNecessaryAndInterior,
95  const vtkm::Id boundaryNecessaryId,
96  const InFieldPortalType meshSortOrderPortal,
97  const OutFieldPortalType& boundaryIndicesPortal,
98  const OutFieldPortalType& bractVertexSupersetPortal) const
99  {
100  // per supernode
101  if (isNecessaryAndInterior)
102  { // if necessary
104  // add to last index in old boundary to find where to put it
105  vtkm::Id wherePut = this->NumBoundary - 1 + boundaryNecessaryId;
106  boundaryIndicesPortal.Set(wherePut, sortIndex);
107  bractVertexSupersetPortal.Set(wherePut, meshSortOrderPortal.Get(sortIndex));
108  } // if necessary
109 
110  // In serial this worklet implements the following operation
111  /*
112  for (indexType supernode = 0; supernode < contourTree->supernodes.size(); supernode++)
113  { // per supernode
114  if (isNecessaryAndInterior[supernode])
115  { // if necessary
116  indexType sortIndex = maskedIndex(contourTree->supernodes[supernode]);
117  // add to last index in old boundary to find where to put it
118  indexType wherePut = nBoundary - 1 + boundaryNecessaryID[supernode];
119  boundaryIndices[wherePut] = sortIndex;
120  bractVertexSuperset[wherePut] = mesh->SortOrder(sortIndex);
121  } // if necessary
122  } // per supernode
123  */
124  }
125 
126 private:
128 
129 }; // AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet
130 
131 
132 } // namespace bract_maker
133 } // namespace contourtree_distributed
134 } // namespace worklet
135 } // namespace vtkm
136 
137 #endif
vtkm::worklet::contourtree_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet::NumBoundary
vtkm::Id NumBoundary
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:127
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_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet
VTKM_EXEC_CONT AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet(vtkm::Id numBoundary)
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:86
vtkm::worklet::contourtree_augmented::MaskedIndex
VTKM_EXEC_CONT vtkm::Id MaskedIndex(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:127
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::contourtree_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet::InputDomain
_1 InputDomain
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:82
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::worklet::contourtree_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet::ExecutionSignature
void(_1, _2, _3, _4, _5, _6) ExecutionSignature
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:81
Types.h
vtkm::worklet::contourtree_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet
Worklet to transfer the dependent counts for hyperarcs Part of the BoundaryRestrictedAugmentedContour...
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:70
vtkm::worklet::contourtree_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet::operator()
VTKM_EXEC void operator()(const vtkm::Id &supernode, const bool &isNecessaryAndInterior, const vtkm::Id boundaryNecessaryId, const InFieldPortalType meshSortOrderPortal, const OutFieldPortalType &boundaryIndicesPortal, const OutFieldPortalType &bractVertexSupersetPortal) const
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:93
vtkm::worklet::contourtree_distributed::bract_maker::AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet::ControlSignature
void(FieldIn supernodes, FieldIn isNecessaryAndInterior, FieldIn boundaryNecessaryId, WholeArrayIn meshSortOrder, WholeArrayOut boundaryIndices, WholeArrayOut bractVertexSuperset) ControlSignature
Definition: AugmentBoundaryWithNecessaryInteriorSupernodesAppendNecessarySupernodesWorklet.h:80
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38