FieldNeighborhood.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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.
//============================================================================
#ifndef viskores_exec_FieldNeighborhood_h
#define viskores_exec_FieldNeighborhood_h
 
#include <viskores/exec/BoundaryState.h>
#include <viskores/internal/ArrayPortalUniformPointCoordinates.h>
 
namespace viskores
{
namespace exec
{
 
template <typename FieldPortalType>
struct FieldNeighborhood
{
  VISKORES_EXEC
  FieldNeighborhood(const FieldPortalType& portal, const viskores::exec::BoundaryState& boundary)
    : Boundary(&boundary)
    , Portal(portal)
  {
  }
 
  using ValueType = typename FieldPortalType::ValueType;
 
  VISKORES_EXEC
  ValueType Get(viskores::IdComponent i, viskores::IdComponent j, viskores::IdComponent k) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFlatIndexClamp(i, j, k));
  }
 
  VISKORES_EXEC
  ValueType GetUnchecked(viskores::IdComponent i,
                         viskores::IdComponent j,
                         viskores::IdComponent k) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFlatIndex(i, j, k));
  }
 
  VISKORES_EXEC
  ValueType Get(const viskores::Id3& ijk) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFlatIndexClamp(ijk));
  }
 
  VISKORES_EXEC
  ValueType GetUnchecked(const viskores::Id3& ijk) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFlatIndex(ijk));
  }
 
  viskores::exec::BoundaryState const* const Boundary;
 
  FieldPortalType Portal;
};
 
template <>
struct FieldNeighborhood<viskores::internal::ArrayPortalUniformPointCoordinates>
{
  VISKORES_EXEC
  FieldNeighborhood(const viskores::internal::ArrayPortalUniformPointCoordinates& portal,
                    const viskores::exec::BoundaryState& boundary)
    : Boundary(&boundary)
    , Portal(portal)
  {
  }
 
  using ValueType = viskores::internal::ArrayPortalUniformPointCoordinates::ValueType;
 
  VISKORES_EXEC
  ValueType Get(viskores::IdComponent i, viskores::IdComponent j, viskores::IdComponent k) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFullIndexClamp(i, j, k));
  }
 
  VISKORES_EXEC
  ValueType GetUnchecked(viskores::IdComponent i,
                         viskores::IdComponent j,
                         viskores::IdComponent k) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFullIndex(i, j, k));
  }
 
  VISKORES_EXEC
  ValueType Get(const viskores::IdComponent3& ijk) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFullIndexClamp(ijk));
  }
 
  VISKORES_EXEC
  ValueType GetUnchecked(const viskores::IdComponent3& ijk) const
  {
    return Portal.Get(this->Boundary->NeighborIndexToFullIndex(ijk));
  }
 
  viskores::exec::BoundaryState const* const Boundary;
  viskores::internal::ArrayPortalUniformPointCoordinates Portal;
};
}
} // namespace viskores::exec
 
#endif //viskores_exec_FieldNeighborhood_h