vtk-m/vtkm/worklet/contourtree_distributed/CombineHyperSweepBlockFunctor.h

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
// Copyright (c) 2018, The Regents of the University of California, through
// Lawrence Berkeley National Laboratory (subject to receipt of any required approvals
// from the U.S. Dept. of Energy).  All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright notice, this
//     list of conditions and the following disclaimer.
//
// (2) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//
// (3) Neither the name of the University of California, Lawrence Berkeley National
//     Laboratory, U.S. Dept. of Energy nor the names of its contributors may be
//     used to endorse or promote products derived from this software without
//     specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//
//=============================================================================
//
//  This code is an extension of the algorithm presented in the paper:
//  Parallel Peak Pruning for Scalable SMP Contour Tree Computation.
//  Hamish Carr, Gunther Weber, Christopher Sewell, and James Ahrens.
//  Proceedings of the IEEE Symposium on Large Data Analysis and Visualization
//  (LDAV), October 2016, Baltimore, Maryland.
//
//  The PPP2 algorithm and software were jointly developed by
//  Hamish Carr (University of Leeds), Gunther H. Weber (LBNL), and
//  Oliver Ruebel (LBNL)
//==============================================================================

#ifndef vtk_m_worklet_contourtree_distributed_combinehypersweepblockfunctor_h
#define vtk_m_worklet_contourtree_distributed_combinehypersweepblockfunctor_h

#include <vtkm/Types.h>
#include <vtkm/cont/ArrayHandle.h>
#include <vtkm/worklet/contourtree_distributed/HyperSweepBlock.h>

// clang-format off
VTKM_THIRDPARTY_PRE_INCLUDE
#include <vtkm/thirdparty/diy/diy.h>
VTKM_THIRDPARTY_POST_INCLUDE
// clang-format on


namespace vtkm
{
namespace worklet
{
namespace contourtree_distributed
{

template <typename ContourTreeDataFieldType>
struct CobmineHyperSweepBlockFunctor
{
  void operator()(
    vtkm::worklet::contourtree_distributed::HyperSweepBlock<ContourTreeDataFieldType>* b,
    const vtkmdiy::ReduceProxy& rp,     // communication proxy
    const vtkmdiy::RegularSwapPartners& // partners of the current block (unused)
  ) const
  {
    // Get our rank and DIY id
    //const vtkm::Id rank = vtkm::cont::EnvironmentTracker::GetCommunicator().rank();
    const auto selfid = rp.gid();

    std::vector<int> incoming;
    rp.incoming(incoming);

    for (const int ingid : incoming)
    {
      std::cout << rp.round() << std::endl;
      auto roundNo = rp.round() - 1;
      // NOTE/IMPORTANT: In each round we should have only one swap partner (despite for-loop here).
      // If that assumption does not hold, it will break things.
      // NOTE/IMPORTANT: This assumption only holds if the number of blocks is a power of two.
      // Otherwise, we may need to process more than one incoming block
      if (ingid != selfid)
      {
        vtkm::Id incomingBlockNo;
        rp.dequeue(ingid, incomingBlockNo);
        // std::cout << "Combining block " << b->BlockNo << " with " << incomingBlockNo << std::endl;
        vtkm::cont::ArrayHandle<vtkm::Id> incomingIntrinsicVolume;
        rp.dequeue(ingid, incomingIntrinsicVolume);
        vtkm::cont::ArrayHandle<vtkm::Id> incomingDependentVolume;
        rp.dequeue(ingid, incomingDependentVolume);

        // TODO/FIXME: Replace with something more efficient
        vtkm::Id numSupernodesToProcess =
          b->HierarchicalContourTree.FirstSupernodePerIteration[roundNo].ReadPortal().Get(0);

        /*
        std::cout << "Block " << b->BlockNo << " Round " << roundNo << ": " << numSupernodesToProcess << " entries to process" << std::endl;

        vtkm::worklet::contourtree_augmented::PrintIndices(
            "Intrinsic Volume (B)", b->IntrinsicVolume, -1, std::cout);
        vtkm::worklet::contourtree_augmented::PrintIndices(
            "Dependent Volume (B)", b->DependentVolume, -1, std::cout);
        */
        auto intrinsicVolumeView =
          make_ArrayHandleView(b->IntrinsicVolume, 0, numSupernodesToProcess);
        auto incomingIntrinsicVolumeView =
          make_ArrayHandleView(incomingIntrinsicVolume, 0, numSupernodesToProcess);
        vtkm::cont::ArrayHandle<vtkm::Id> tempSum;
        vtkm::cont::Algorithm::Transform(
          intrinsicVolumeView, incomingIntrinsicVolumeView, tempSum, vtkm::Sum());
        vtkm::cont::Algorithm::Copy(tempSum, intrinsicVolumeView);

        auto dependentVolumeView =
          make_ArrayHandleView(b->DependentVolume, 0, numSupernodesToProcess);
        auto incomingDependentVolumeView =
          make_ArrayHandleView(incomingDependentVolume, 0, numSupernodesToProcess);
        vtkm::cont::Algorithm::Transform(
          dependentVolumeView, incomingDependentVolumeView, tempSum, vtkm::Sum());
        vtkm::cont::Algorithm::Copy(tempSum, dependentVolumeView);

        /*
        vtkm::worklet::contourtree_augmented::PrintIndices(
          "Intrinsic Volume (A)", b->IntrinsicVolume, -1, std::cout);
        vtkm::worklet::contourtree_augmented::PrintIndices(
          "Dependent Volume (A)", b->DependentVolume, -1, std::cout);
        */
      }
    }

    for (int cc = 0; cc < rp.out_link().size(); ++cc)
    {
      auto target = rp.out_link().target(cc);
      if (target.gid != selfid)
      {
        rp.enqueue(target, b->BlockNo);
        rp.enqueue(target, b->IntrinsicVolume);
        rp.enqueue(target, b->DependentVolume);
      }
    }
  }
};

} // namespace contourtree_distributed
} // namespace worklet
} // namespace vtkm

#endif