ThreadIndicesTopologyMap.h

Go to the documentation of this file.

//============================================================================
//  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 vtk_m_exec_arg_ThreadIndicesTopologyMap_h
#define vtk_m_exec_arg_ThreadIndicesTopologyMap_h
 
#include <vtkm/exec/arg/ThreadIndicesBasic.h>
 
#include <vtkm/exec/ConnectivityPermuted.h>
#include <vtkm/exec/ConnectivityStructured.h>
 
namespace vtkm
{
namespace exec
{
namespace arg
{
 
namespace detail
{
 
static inline VTKM_EXEC vtkm::Id3 InflateTo3D(vtkm::Id3 index)
{
  return index;
}
 
static inline VTKM_EXEC vtkm::Id3 InflateTo3D(vtkm::Id2 index)
{
  return vtkm::Id3(index[0], index[1], 0);
}
 
static inline VTKM_EXEC vtkm::Id3 InflateTo3D(vtkm::Vec<vtkm::Id, 1> index)
{
  return vtkm::Id3(index[0], 0, 0);
}
 
static inline VTKM_EXEC vtkm::Id3 InflateTo3D(vtkm::Id index)
{
  return vtkm::Id3(index, 0, 0);
}
 
static inline VTKM_EXEC vtkm::Id3 Deflate(const vtkm::Id3& index, vtkm::Id3)
{
  return index;
}
 
static inline VTKM_EXEC vtkm::Id2 Deflate(const vtkm::Id3& index, vtkm::Id2)
{
  return vtkm::Id2(index[0], index[1]);
}
 
} // namespace detail
 
struct DefaultScatterAndMaskTag
{
};
 
struct CustomScatterOrMaskTag
{
};
 
template <typename ConnectivityType, typename ScatterAndMaskMode>
class ThreadIndicesTopologyMap : public vtkm::exec::arg::ThreadIndicesBasic
{
  using Superclass = vtkm::exec::arg::ThreadIndicesBasic;
 
public:
  using IndicesIncidentType = typename ConnectivityType::IndicesType;
  using CellShapeTag = typename ConnectivityType::CellShapeTag;
  using Connectivity = ConnectivityType;
 
  VTKM_SUPPRESS_EXEC_WARNINGS
  VTKM_EXEC ThreadIndicesTopologyMap(vtkm::Id threadIndex,
                                     vtkm::Id inputIndex,
                                     vtkm::IdComponent visitIndex,
                                     vtkm::Id outputIndex,
                                     const ConnectivityType& connectivity)
    : Superclass(threadIndex, inputIndex, visitIndex, outputIndex)
    // The connectivity is stored in the invocation parameter at the given
    // input domain index. If this class is being used correctly, the type
    // of the domain will match the connectivity type used here. If there is
    // a compile error here about a type mismatch, chances are a worklet has
    // set its input domain incorrectly.
    , IndicesIncident(connectivity.GetIndices(inputIndex))
    , CellShape(connectivity.GetCellShape(inputIndex))
  {
  }
 
  VTKM_EXEC
  const IndicesIncidentType& GetIndicesIncident() const { return this->IndicesIncident; }
 
  VTKM_EXEC
  const IndicesIncidentType* GetIndicesIncidentPointer() const { return &this->IndicesIncident; }
 
  VTKM_EXEC
  CellShapeTag GetCellShape() const { return this->CellShape; }
 
private:
  IndicesIncidentType IndicesIncident;
  CellShapeTag CellShape;
};
 
template <typename VisitTopology, typename IncidentTopology, vtkm::IdComponent Dimension>
class ThreadIndicesTopologyMap<
  vtkm::exec::ConnectivityStructured<VisitTopology, IncidentTopology, Dimension>,
  CustomScatterOrMaskTag>
{
  using ConnectivityType =
    vtkm::exec::ConnectivityStructured<VisitTopology, IncidentTopology, Dimension>;
 
public:
  using IndicesIncidentType = typename ConnectivityType::IndicesType;
  using CellShapeTag = typename ConnectivityType::CellShapeTag;
  using LogicalIndexType = typename ConnectivityType::SchedulingRangeType;
  using Connectivity =
    vtkm::exec::ConnectivityStructured<VisitTopology, IncidentTopology, Dimension>;
 
  VTKM_EXEC ThreadIndicesTopologyMap(vtkm::Id threadIndex,
                                     vtkm::Id inputIndex,
                                     vtkm::IdComponent visitIndex,
                                     vtkm::Id outputIndex,
                                     const ConnectivityType& connectivity)
  {
    this->ThreadIndex = threadIndex;
    this->InputIndex = inputIndex;
    this->VisitIndex = visitIndex;
    this->OutputIndex = outputIndex;
    this->LogicalIndex = connectivity.FlatToLogicalVisitIndex(this->InputIndex);
    this->IndicesIncident = connectivity.GetIndices(this->LogicalIndex);
    this->CellShape = connectivity.GetCellShape(this->InputIndex);
  }
 
  VTKM_EXEC ThreadIndicesTopologyMap(const vtkm::Id3& threadIndex3D,
                                     vtkm::Id threadIndex1D,
                                     const ConnectivityType& connectivity)
  {
    // This constructor handles multidimensional indices on one-to-one input-to-output
    auto logicalIndex = detail::Deflate(threadIndex3D, LogicalIndexType());
    this->ThreadIndex = threadIndex1D;
    this->LogicalIndex = logicalIndex;
    this->IndicesIncident = connectivity.GetIndices(logicalIndex);
    this->CellShape = connectivity.GetCellShape(threadIndex1D);
  }
 
  VTKM_EXEC ThreadIndicesTopologyMap(const vtkm::Id3& threadIndex3D,
                                     vtkm::Id threadIndex1D,
                                     vtkm::Id inIndex,
                                     vtkm::IdComponent visitIndex,
                                     vtkm::Id outIndex,
                                     const ConnectivityType& connectivity)
  {
    // This constructor handles multidimensional indices on many-to-many input-to-output
    auto logicalIndex = detail::Deflate(threadIndex3D, LogicalIndexType());
    this->ThreadIndex = threadIndex1D;
    this->InputIndex = inIndex;
    this->VisitIndex = visitIndex;
    this->OutputIndex = outIndex;
    this->LogicalIndex = logicalIndex;
    this->IndicesIncident = connectivity.GetIndices(logicalIndex);
    this->CellShape = connectivity.GetCellShape(threadIndex1D);
  }
 
 
  VTKM_EXEC
  vtkm::Id GetThreadIndex() const { return this->ThreadIndex; }
 
  VTKM_EXEC
  LogicalIndexType GetIndexLogical() const { return this->LogicalIndex; }
 
  VTKM_EXEC
  vtkm::Id GetInputIndex() const { return this->InputIndex; }
 
  VTKM_EXEC
  vtkm::Id3 GetInputIndex3D() const { return detail::InflateTo3D(this->GetIndexLogical()); }
 
  VTKM_EXEC
  vtkm::Id GetOutputIndex() const { return this->OutputIndex; }
 
  VTKM_EXEC
  vtkm::IdComponent GetVisitIndex() const { return this->VisitIndex; }
 
  VTKM_EXEC
  const IndicesIncidentType& GetIndicesIncident() const { return this->IndicesIncident; }
 
  VTKM_EXEC
  const IndicesIncidentType* GetIndicesIncidentPointer() const { return &this->IndicesIncident; }
 
  VTKM_EXEC
  CellShapeTag GetCellShape() const { return this->CellShape; }
 
private:
  vtkm::Id ThreadIndex;
  vtkm::IdComponent VisitIndex;
  LogicalIndexType LogicalIndex;
  IndicesIncidentType IndicesIncident;
  CellShapeTag CellShape;
  vtkm::Id InputIndex;
  vtkm::Id OutputIndex;
};
 
template <typename VisitTopology, typename IncidentTopology, vtkm::IdComponent Dimension>
class ThreadIndicesTopologyMap<
  vtkm::exec::ConnectivityStructured<VisitTopology, IncidentTopology, Dimension>,
  DefaultScatterAndMaskTag>
{
  using ConnectivityType =
    vtkm::exec::ConnectivityStructured<VisitTopology, IncidentTopology, Dimension>;
 
public:
  using IndicesIncidentType = typename ConnectivityType::IndicesType;
  using CellShapeTag = typename ConnectivityType::CellShapeTag;
  using LogicalIndexType = typename ConnectivityType::SchedulingRangeType;
  using Connectivity = ConnectivityType;
 
  VTKM_EXEC ThreadIndicesTopologyMap(vtkm::Id threadIndex,
                                     vtkm::Id inputIndex,
                                     vtkm::IdComponent vtkmNotUsed(visitIndex),
                                     vtkm::Id vtkmNotUsed(outputIndex),
                                     const ConnectivityType& connectivity)
  {
    this->ThreadIndex = threadIndex;
    this->LogicalIndex = connectivity.FlatToLogicalVisitIndex(inputIndex);
    this->IndicesIncident = connectivity.GetIndices(this->LogicalIndex);
    this->CellShape = connectivity.GetCellShape(inputIndex);
  }
 
 
 
 
  VTKM_EXEC ThreadIndicesTopologyMap(const vtkm::Id3& threadIndex3D,
                                     vtkm::Id threadIndex1D,
                                     const ConnectivityType& connectivity)
  {
    // This constructor handles multidimensional indices on one-to-one input-to-output
    auto logicalIndex = detail::Deflate(threadIndex3D, LogicalIndexType());
    this->ThreadIndex = threadIndex1D;
    this->LogicalIndex = logicalIndex;
    this->IndicesIncident = connectivity.GetIndices(logicalIndex);
    this->CellShape = connectivity.GetCellShape(threadIndex1D);
  }
 
  VTKM_EXEC ThreadIndicesTopologyMap(const vtkm::Id3& threadIndex3D,
                                     vtkm::Id threadIndex1D,
                                     vtkm::Id vtkmNotUsed(inIndex),
                                     vtkm::IdComponent vtkmNotUsed(visitIndex),
                                     vtkm::Id vtkmNotUsed(outIndex),
                                     const ConnectivityType& connectivity)
  {
    // This constructor handles multidimensional indices on many-to-many input-to-output
    auto logicalIndex = detail::Deflate(threadIndex3D, LogicalIndexType());
    this->ThreadIndex = threadIndex1D;
    this->LogicalIndex = logicalIndex;
    this->IndicesIncident = connectivity.GetIndices(logicalIndex);
    this->CellShape = connectivity.GetCellShape(threadIndex1D);
  }
 
  VTKM_EXEC
  vtkm::Id GetThreadIndex() const { return this->ThreadIndex; }
 
  VTKM_EXEC
  LogicalIndexType GetIndexLogical() const { return this->LogicalIndex; }
 
  VTKM_EXEC
  vtkm::Id GetInputIndex() const { return this->ThreadIndex; }
 
  VTKM_EXEC
  vtkm::Id3 GetInputIndex3D() const { return detail::InflateTo3D(this->GetIndexLogical()); }
 
  VTKM_EXEC
  vtkm::Id GetOutputIndex() const { return this->ThreadIndex; }
 
  VTKM_EXEC
  vtkm::IdComponent GetVisitIndex() const { return 0; }
 
  VTKM_EXEC
  const IndicesIncidentType& GetIndicesIncident() const { return this->IndicesIncident; }
 
  VTKM_EXEC
  const IndicesIncidentType* GetIndicesIncidentPointer() const { return &this->IndicesIncident; }
 
  VTKM_EXEC
  CellShapeTag GetCellShape() const { return this->CellShape; }
 
private:
  vtkm::Id ThreadIndex;
  LogicalIndexType LogicalIndex;
  IndicesIncidentType IndicesIncident;
  CellShapeTag CellShape;
};
 
 
template <typename PermutationPortal, vtkm::IdComponent Dimension>
class ThreadIndicesTopologyMap<vtkm::exec::ConnectivityPermutedVisitCellsWithPoints<
                                 PermutationPortal,
                                 vtkm::exec::ConnectivityStructured<vtkm::TopologyElementTagCell,
                                                                    vtkm::TopologyElementTagPoint,
                                                                    Dimension>>,
                               CustomScatterOrMaskTag>
{
  using PermutedConnectivityType = vtkm::exec::ConnectivityPermutedVisitCellsWithPoints<
    PermutationPortal,
    vtkm::exec::ConnectivityStructured<vtkm::TopologyElementTagCell,
                                       vtkm::TopologyElementTagPoint,
                                       Dimension>>;
  using ConnectivityType = vtkm::exec::
    ConnectivityStructured<vtkm::TopologyElementTagCell, vtkm::TopologyElementTagPoint, Dimension>;
 
public:
  using IndicesIncidentType = typename ConnectivityType::IndicesType;
  using CellShapeTag = typename ConnectivityType::CellShapeTag;
  using LogicalIndexType = typename ConnectivityType::SchedulingRangeType;
  using Connectivity = vtkm::exec::ConnectivityPermutedVisitCellsWithPoints<
    PermutationPortal,
    vtkm::exec::ConnectivityStructured<vtkm::TopologyElementTagCell,
                                       vtkm::TopologyElementTagPoint,
                                       Dimension>>;
 
  VTKM_EXEC ThreadIndicesTopologyMap(vtkm::Id threadIndex,
                                     vtkm::Id inputIndex,
                                     vtkm::IdComponent visitIndex,
                                     vtkm::Id outputIndex,
                                     const PermutedConnectivityType& permutation)
  {
    this->ThreadIndex = threadIndex;
    this->InputIndex = inputIndex;
    this->VisitIndex = visitIndex;
    this->OutputIndex = outputIndex;
 
    const vtkm::Id permutedIndex = permutation.Portal.Get(this->InputIndex);
    this->LogicalIndex = permutation.Connectivity.FlatToLogicalVisitIndex(permutedIndex);
    this->IndicesIncident = permutation.Connectivity.GetIndices(this->LogicalIndex);
    this->CellShape = permutation.Connectivity.GetCellShape(permutedIndex);
  }
 
  VTKM_EXEC
  vtkm::Id GetThreadIndex() const { return this->ThreadIndex; }
 
  VTKM_EXEC
  LogicalIndexType GetIndexLogical() const { return this->LogicalIndex; }
 
  VTKM_EXEC
  vtkm::Id GetInputIndex() const { return this->InputIndex; }
 
  VTKM_EXEC
  vtkm::Id3 GetInputIndex3D() const { return detail::InflateTo3D(this->GetIndexLogical()); }
 
  VTKM_EXEC
  vtkm::Id GetOutputIndex() const { return this->OutputIndex; }
 
  VTKM_EXEC
  vtkm::IdComponent GetVisitIndex() const { return this->VisitIndex; }
 
  VTKM_EXEC
  const IndicesIncidentType& GetIndicesIncident() const { return this->IndicesIncident; }
 
  VTKM_EXEC
  const IndicesIncidentType* GetIndicesIncidentPointer() const { return &this->IndicesIncident; }
 
  VTKM_EXEC
  CellShapeTag GetCellShape() const { return this->CellShape; }
 
private:
  vtkm::Id ThreadIndex;
  vtkm::Id InputIndex;
  vtkm::IdComponent VisitIndex;
  vtkm::Id OutputIndex;
  LogicalIndexType LogicalIndex;
  IndicesIncidentType IndicesIncident;
  CellShapeTag CellShape;
};
}
}
} // namespace vtkm::exec::arg
 
#endif //vtk_m_exec_arg_ThreadIndicesTopologyMap_h