VTK-m  2.0
ContourTreeBlockData.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_contourtreeblockdata_h
54 #define vtk_m_worklet_contourtree_distributed_contourtreeblockdata_h
55 
56 #include <vtkm/Types.h>
58 
59 // clang-format off
60 VTKM_THIRDPARTY_PRE_INCLUDE
61 #include <vtkm/thirdparty/diy/diy.h>
62 VTKM_THIRDPARTY_POST_INCLUDE
63 // clang-format on
64 
65 
66 namespace vtkm
67 {
68 namespace worklet
69 {
70 namespace contourtree_distributed
71 {
72 template <typename FieldType>
74 {
75  static void* create() { return new ContourTreeBlockData<FieldType>; }
76  static void destroy(void* b) { delete static_cast<ContourTreeBlockData<FieldType>*>(b); }
77 
78  // ContourTreeMesh data
85 
86  // Block metadata
87  vtkm::Id3 BlockOrigin; // Origin of the data block
88  vtkm::Id3 BlockSize; // Extends of the data block
89  vtkm::Id3 GlobalSize; // Extends of the global mesh
90  unsigned int ComputeRegularStructure; // pass through augmentation setting
91 };
92 } // namespace contourtree_distributed
93 } // namespace worklet
94 } // namespace vtkm
95 
96 
97 namespace vtkmdiy
98 {
99 
100 // Struct to serialize ContourBlockData objects (i.e., load/save) needed in parralle for DIY
101 template <typename FieldType>
102 struct Serialization<vtkm::worklet::contourtree_distributed::ContourTreeBlockData<FieldType>>
103 {
104  static void save(
105  vtkmdiy::BinaryBuffer& bb,
107  {
108  vtkmdiy::save(bb, block.NumVertices);
109  vtkmdiy::save(bb, block.SortedValue);
110  vtkmdiy::save(bb, block.GlobalMeshIndex);
111  vtkmdiy::save(bb, block.NeighborConnectivity);
112  vtkmdiy::save(bb, block.NeighborOffsets);
113  vtkmdiy::save(bb, block.MaxNeighbors);
114  vtkmdiy::save(bb, block.BlockOrigin);
115  vtkmdiy::save(bb, block.BlockSize);
116  vtkmdiy::save(bb, block.GlobalSize);
117  vtkmdiy::save(bb, block.ComputeRegularStructure);
118  }
119 
120  static void load(vtkmdiy::BinaryBuffer& bb,
122  {
123  vtkmdiy::load(bb, block.NumVertices);
124  vtkmdiy::load(bb, block.SortedValue);
125  vtkmdiy::load(bb, block.GlobalMeshIndex);
127  vtkmdiy::load(bb, block.NeighborOffsets);
128  vtkmdiy::load(bb, block.MaxNeighbors);
129  vtkmdiy::load(bb, block.BlockOrigin);
130  vtkmdiy::load(bb, block.BlockSize);
131  vtkmdiy::load(bb, block.GlobalSize);
133  }
134 };
135 
136 } // namespace mangled_vtkmdiy_namespace
137 
138 
139 #endif
vtkm::cont::ArrayHandle< FieldType >
vtkm::worklet::contourtree_distributed::ContourTreeBlockData
Definition: ContourTreeBlockData.h:73
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::NeighborOffsets
vtkm::worklet::contourtree_augmented::IdArrayType NeighborOffsets
Definition: ContourTreeBlockData.h:83
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkmdiy::Serialization< vtkm::worklet::contourtree_distributed::ContourTreeBlockData< FieldType > >::load
static void load(vtkmdiy::BinaryBuffer &bb, vtkm::worklet::contourtree_distributed::ContourTreeBlockData< FieldType > &block)
Definition: ContourTreeBlockData.h:120
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::GlobalMeshIndex
vtkm::worklet::contourtree_augmented::IdArrayType GlobalMeshIndex
Definition: ContourTreeBlockData.h:81
Types.h
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::MaxNeighbors
vtkm::Id MaxNeighbors
Definition: ContourTreeBlockData.h:84
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::NumVertices
vtkm::Id NumVertices
Definition: ContourTreeBlockData.h:79
vtkmdiy::Serialization< vtkm::worklet::contourtree_distributed::ContourTreeBlockData< FieldType > >::save
static void save(vtkmdiy::BinaryBuffer &bb, const vtkm::worklet::contourtree_distributed::ContourTreeBlockData< FieldType > &block)
Definition: ContourTreeBlockData.h:104
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::exec::arg::load
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC T load(const U &u, vtkm::Id v)
Definition: FetchTagArrayDirectIn.h:36
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::NeighborConnectivity
vtkm::worklet::contourtree_augmented::IdArrayType NeighborConnectivity
Definition: ContourTreeBlockData.h:82
Types.h
vtkmdiy
Definition: ContourTreeBlockData.h:97
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::BlockSize
vtkm::Id3 BlockSize
Definition: ContourTreeBlockData.h:88
vtkm::Vec< vtkm::Id, 3 >
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::ComputeRegularStructure
unsigned int ComputeRegularStructure
Definition: ContourTreeBlockData.h:90
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::destroy
static void destroy(void *b)
Definition: ContourTreeBlockData.h:76
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::SortedValue
vtkm::cont::ArrayHandle< FieldType > SortedValue
Definition: ContourTreeBlockData.h:80
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::create
static void * create()
Definition: ContourTreeBlockData.h:75
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::BlockOrigin
vtkm::Id3 BlockOrigin
Definition: ContourTreeBlockData.h:87
vtkm::worklet::contourtree_distributed::ContourTreeBlockData::GlobalSize
vtkm::Id3 GlobalSize
Definition: ContourTreeBlockData.h:89