vtk-m/vtkm/exec/arg/FetchTagArrayTopologyMapIn.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 Sandia Corporation.
//  Copyright 2014 UT-Battelle, LLC.
//  Copyright 2014 Los Alamos National Security.
//
//  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
//  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.
//============================================================================
#ifndef vtk_m_exec_arg_FetchTagArrayTopologyMapIn_h
#define vtk_m_exec_arg_FetchTagArrayTopologyMapIn_h

#include <vtkm/exec/arg/AspectTagDefault.h>
#include <vtkm/exec/arg/Fetch.h>
#include <vtkm/exec/arg/ThreadIndicesTopologyMap.h>

#include <vtkm/TopologyElementTag.h>

#include <vtkm/internal/ArrayPortalUniformPointCoordinates.h>

#include <vtkm/exec/ConnectivityStructured.h>
#include <vtkm/VecRectilinearPointCoordinates.h>

#include <vtkm/exec/internal/VecFromPortalPermute.h>

namespace vtkm {
namespace exec {
namespace arg {

/// \brief \c Fetch tag for getting array values determined by topology connections.
///
/// \c FetchTagArrayTopologyMapIn is a tag used with the \c Fetch class to
/// retreive values from an array portal. The fetch uses indexing based on
/// the topology structure used for the input domain.
///
struct FetchTagArrayTopologyMapIn {  };

namespace detail {

// This internal class defines how a TopologyMapIn fetch loads from field data
// based on the connectivity class and the object holding the field data. The
// default implementation gets a Vec of indices and an array portal for the
// field and delivers a VecFromPortalPermute. Specializations could have more
// efficient implementations. For example, if the connectivity is structured
// and the field is regular point coordinates, it is much faster to compute the
// field directly.

template<typename ConnectivityType, typename FieldExecObjectType>
struct FetchArrayTopologyMapInImplementation
{
  typedef vtkm::exec::arg::ThreadIndicesTopologyMap<ConnectivityType>
      ThreadIndicesType;

  // ThreadIndicesTopologyMap has special "from" indices that are stored in a
  // Vec-like object.
  typedef typename ThreadIndicesType::IndicesFromType IndexVecType;

  // The FieldExecObjectType is expected to behave like an ArrayPortal.
  typedef FieldExecObjectType PortalType;

  typedef vtkm::exec::internal::VecFromPortalPermute<
      IndexVecType,PortalType> ValueType;

  VTKM_SUPPRESS_EXEC_WARNINGS
  VTKM_EXEC_EXPORT
  static ValueType Load(const ThreadIndicesType &indices,
                        const FieldExecObjectType &field)
  {
    // It is important that we give the VecFromPortalPermute (ValueType) a
    // pointer that will stay around during the time the Vec is valid. Thus, we
    // should make sure that indices is a reference that goes up the stack at
    // least as far as the returned VecFromPortalPermute is used.
    return ValueType(indices.GetIndicesFromPointer(), field);
  }
};

VTKM_EXEC_EXPORT
vtkm::VecRectilinearPointCoordinates<1>
make_VecRectilinearPointCoordinates(
    const vtkm::Vec<vtkm::FloatDefault,3> &origin,
    const vtkm::Vec<vtkm::FloatDefault,3> &spacing,
    const vtkm::Vec<vtkm::Id,1> &logicalId)
{
  vtkm::Vec<vtkm::FloatDefault,3> offsetOrigin(
        origin[0] + spacing[0]*static_cast<vtkm::FloatDefault>(logicalId[0]),
        origin[1],
        origin[2]);
  return vtkm::VecRectilinearPointCoordinates<1>(offsetOrigin, spacing);
}

VTKM_EXEC_EXPORT
vtkm::VecRectilinearPointCoordinates<2>
make_VecRectilinearPointCoordinates(
    const vtkm::Vec<vtkm::FloatDefault,3> &origin,
    const vtkm::Vec<vtkm::FloatDefault,3> &spacing,
    const vtkm::Vec<vtkm::Id,2> &logicalId)
{
  vtkm::Vec<vtkm::FloatDefault,3> offsetOrigin(
        origin[0] + spacing[0]*static_cast<vtkm::FloatDefault>(logicalId[0]),
        origin[1] + spacing[1]*static_cast<vtkm::FloatDefault>(logicalId[1]),
        origin[2]);
  return vtkm::VecRectilinearPointCoordinates<2>(offsetOrigin, spacing);
}

VTKM_EXEC_EXPORT
vtkm::VecRectilinearPointCoordinates<3>
make_VecRectilinearPointCoordinates(
    const vtkm::Vec<vtkm::FloatDefault,3> &origin,
    const vtkm::Vec<vtkm::FloatDefault,3> &spacing,
    const vtkm::Vec<vtkm::Id,3> &logicalId)
{
  vtkm::Vec<vtkm::FloatDefault,3> offsetOrigin(
        origin[0] + spacing[0]*static_cast<vtkm::FloatDefault>(logicalId[0]),
        origin[1] + spacing[1]*static_cast<vtkm::FloatDefault>(logicalId[1]),
        origin[2] + spacing[2]*static_cast<vtkm::FloatDefault>(logicalId[2]));
  return vtkm::VecRectilinearPointCoordinates<3>(offsetOrigin, spacing);
}

template<vtkm::IdComponent NumDimensions>
struct FetchArrayTopologyMapInImplementation<
    vtkm::exec::ConnectivityStructured<vtkm::TopologyElementTagPoint,
                                       vtkm::TopologyElementTagCell,
                                       NumDimensions>,
    vtkm::internal::ArrayPortalUniformPointCoordinates>

{
  typedef vtkm::exec::ConnectivityStructured<vtkm::TopologyElementTagPoint,
                                             vtkm::TopologyElementTagCell,
                                             NumDimensions> ConnectivityType;
  typedef vtkm::exec::arg::ThreadIndicesTopologyMap<ConnectivityType>
      ThreadIndicesType;

  typedef vtkm::VecRectilinearPointCoordinates<NumDimensions> ValueType;

  VTKM_SUPPRESS_EXEC_WARNINGS
  VTKM_EXEC_EXPORT
  static ValueType Load(
      const ThreadIndicesType &indices,
      const vtkm::internal::ArrayPortalUniformPointCoordinates &field)
  {
    // This works because the logical cell index is the same as the logical
    // point index of the first point on the cell.
    return vtkm::exec::arg::detail::make_VecRectilinearPointCoordinates(
          field.GetOrigin(),
          field.GetSpacing(),
          indices.GetIndexLogical());
  }
};

} // namespace detail

template<typename ConnectivityType, typename ExecObjectType>
struct Fetch<
    vtkm::exec::arg::FetchTagArrayTopologyMapIn,
    vtkm::exec::arg::AspectTagDefault,
    vtkm::exec::arg::ThreadIndicesTopologyMap<ConnectivityType>,
    ExecObjectType>
{
  typedef vtkm::exec::arg::ThreadIndicesTopologyMap<ConnectivityType>
      ThreadIndicesType;

  typedef detail::FetchArrayTopologyMapInImplementation<
      ConnectivityType,ExecObjectType> Implementation;

  typedef typename Implementation::ValueType ValueType;

  VTKM_SUPPRESS_EXEC_WARNINGS
  VTKM_EXEC_EXPORT
  ValueType Load(const ThreadIndicesType &indices,
                 const ExecObjectType &field) const
  {
    return Implementation::Load(indices, field);
  }

  VTKM_EXEC_EXPORT
  void Store(const ThreadIndicesType &,
             const ExecObjectType &,
             const ValueType &) const
  {
    // Store is a no-op for this fetch.
  }
};

}
}
} // namespace vtkm::exec::arg

#endif //vtk_m_exec_arg_FetchTagArrayTopologyMapIn_h