vtk-m/vtkm/worklet/cosmotools/ComputePotentialBin.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 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
//  Copyright 2014 UT-Battelle, LLC.
//  Copyright 2014 Los Alamos National Security.
//
//  Under the terms of Contract DE-NA0003525 with NTESS,
//  the U.S. Government retains certain rights in this software.
//
//  Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
//  Laboratory (LANL), the U.S. Government retains certain rights in
//  this software.
//============================================================================
//  Copyright (c) 2016, Los Alamos National Security, LLC
//  All rights reserved.
//
//  Copyright 2016. Los Alamos National Security, LLC.
//  This software was produced under U.S. Government contract DE-AC52-06NA25396
//  for Los Alamos National Laboratory (LANL), which is operated by
//  Los Alamos National Security, LLC for the U.S. Department of Energy.
//  The U.S. Government has rights to use, reproduce, and distribute this
//  software.  NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC
//  MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE
//  USE OF THIS SOFTWARE.  If software is modified to produce derivative works,
//  such modified software should be clearly marked, so as not to confuse it
//  with the version available from LANL.
//
//  Additionally, 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 Los Alamos National Security, LLC, Los Alamos
//     National Laboratory, LANL, the U.S. Government, 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 LOS ALAMOS NATIONAL SECURITY, LLC 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 LOS ALAMOS
//  NATIONAL SECURITY, LLC 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.
//============================================================================

#ifndef vtkm_worklet_cosmotools_compute_potential_bin_h
#define vtkm_worklet_cosmotools_compute_potential_bin_h

#include <vtkm/worklet/WorkletMapField.h>

namespace vtkm
{
namespace worklet
{
namespace cosmotools
{

// Worklet for computing the potential for a bin in one halo
template <typename T>
class ComputePotentialBin : public vtkm::worklet::WorkletMapField
{
public:
  struct TagType : vtkm::ListTagBase<T>
  {
  };

  using ControlSignature = void(FieldIn<IdType> binId,         // (input) bin Id
                                WholeArrayIn<IdType> binCount, // (input) particles per bin
                                WholeArrayIn<IdType> binX,     // (input) x index in bin
                                WholeArrayIn<IdType> binY,     // (input) y index in bin
                                WholeArrayIn<IdType> binZ,     // (input) z index in bin
                                FieldInOut<TagType> bestPot,   // (output) best potential estimate
                                FieldInOut<TagType> worstPot); // (output) worst potential estimate
  using ExecutionSignature = void(_1, _2, _3, _4, _5, _6, _7);
  using InputDomain = _1;

  vtkm::Id nBins; // Number of bins
  T mass;         // Particle mass
  T linkLen;      // Linking length is side of bin

  // Constructor
  VTKM_EXEC_CONT
  ComputePotentialBin(vtkm::Id N, T Mass, T LinkLen)
    : nBins(N)
    , mass(Mass)
    , linkLen(LinkLen)
  {
  }

  template <typename InIdPortalType>
  VTKM_EXEC void operator()(const vtkm::Id& i,
                            const InIdPortalType& count,
                            const InIdPortalType& binX,
                            const InIdPortalType& binY,
                            const InIdPortalType& binZ,
                            T& bestPotential,
                            T& worstPotential) const
  {
    vtkm::Id ibinX = binX.Get(i);
    vtkm::Id ibinY = binY.Get(i);
    vtkm::Id ibinZ = binZ.Get(i);

    for (vtkm::Id j = 0; j < nBins; j++)
    {
      vtkm::Id xDelta = vtkm::Abs(ibinX - binX.Get(j));
      vtkm::Id yDelta = vtkm::Abs(ibinY - binY.Get(j));
      vtkm::Id zDelta = vtkm::Abs(ibinZ - binZ.Get(j));

      if ((count.Get(j) != 0) && (xDelta > 1) && (yDelta > 1) && (zDelta > 1))
      {
        T xDistNear = static_cast<T>((xDelta - 1)) * linkLen;
        T yDistNear = static_cast<T>((yDelta - 1)) * linkLen;
        T zDistNear = static_cast<T>((zDelta - 1)) * linkLen;
        T xDistFar = static_cast<T>((xDelta + 1)) * linkLen;
        T yDistFar = static_cast<T>((yDelta + 1)) * linkLen;
        T zDistFar = static_cast<T>((zDelta + 1)) * linkLen;

        T rNear =
          vtkm::Sqrt((xDistNear * xDistNear) + (yDistNear * yDistNear) + (zDistNear * zDistNear));
        T rFar = vtkm::Sqrt((xDistFar * xDistFar) + (yDistFar * yDistFar) + (zDistFar * zDistFar));

        if (rFar > 0.00000000001f)
        {
          worstPotential -= (static_cast<T>(count.Get(j)) * mass) / rFar;
        }
        if (rNear > 0.00000000001f)
        {
          bestPotential -= (static_cast<T>(count.Get(j)) * mass) / rNear;
        }
      }
    }
  }
}; // ComputePotentialBin
}
}
}

#endif