WorkletMapTopology.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_worklet_WorkletMapTopology_h
#define vtk_m_worklet_WorkletMapTopology_h
 
#include <vtkm/worklet/internal/WorkletBase.h>
 
#include <vtkm/TopologyElementTag.h>
 
#include <vtkm/cont/arg/ControlSignatureTagBase.h>
#include <vtkm/cont/arg/TransportTagArrayInOut.h>
#include <vtkm/cont/arg/TransportTagArrayOut.h>
#include <vtkm/cont/arg/TransportTagCellSetIn.h>
#include <vtkm/cont/arg/TransportTagTopologyFieldIn.h>
#include <vtkm/cont/arg/TypeCheckTagArrayIn.h>
#include <vtkm/cont/arg/TypeCheckTagArrayInOut.h>
#include <vtkm/cont/arg/TypeCheckTagArrayOut.h>
#include <vtkm/cont/arg/TypeCheckTagCellSet.h>
 
#include <vtkm/exec/arg/CellShape.h>
#include <vtkm/exec/arg/FetchTagArrayDirectIn.h>
#include <vtkm/exec/arg/FetchTagArrayDirectInOut.h>
#include <vtkm/exec/arg/FetchTagArrayDirectOut.h>
#include <vtkm/exec/arg/FetchTagArrayTopologyMapIn.h>
#include <vtkm/exec/arg/FetchTagCellSetIn.h>
#include <vtkm/exec/arg/IncidentElementCount.h>
#include <vtkm/exec/arg/IncidentElementIndices.h>
#include <vtkm/exec/arg/ThreadIndicesTopologyMap.h>
 
#include <vtkm/worklet/DispatcherMapTopology.h>
 
namespace vtkm
{
namespace worklet
{
 
template <typename WorkletType>
class DispatcherMapTopology;
 
namespace detail
{
 
struct WorkletMapTopologyBase : vtkm::worklet::internal::WorkletBase
{
  template <typename Worklet>
  using Dispatcher = vtkm::worklet::DispatcherMapTopology<Worklet>;
};
 
} // namespace detail
 
template <typename VisitTopology, typename IncidentTopology>
class WorkletMapTopology : public detail::WorkletMapTopologyBase
{
public:
  using VisitTopologyType = VisitTopology;
  using IncidentTopologyType = IncidentTopology;
 
  struct FieldInVisit : vtkm::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayIn;
    using TransportTag = vtkm::cont::arg::TransportTagTopologyFieldIn<VisitTopologyType>;
    using FetchTag = vtkm::exec::arg::FetchTagArrayDirectIn;
  };
 
  struct FieldInIncident : vtkm::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayIn;
    using TransportTag = vtkm::cont::arg::TransportTagTopologyFieldIn<IncidentTopologyType>;
    using FetchTag = vtkm::exec::arg::FetchTagArrayTopologyMapIn;
  };
 
  struct FieldOut : vtkm::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayOut;
    using TransportTag = vtkm::cont::arg::TransportTagArrayOut;
    using FetchTag = vtkm::exec::arg::FetchTagArrayDirectOut;
  };
 
  struct FieldInOut : vtkm::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayInOut;
    using TransportTag = vtkm::cont::arg::TransportTagArrayInOut;
    using FetchTag = vtkm::exec::arg::FetchTagArrayDirectInOut;
  };
 
  struct CellSetIn : vtkm::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = vtkm::cont::arg::TypeCheckTagCellSet;
    using TransportTag =
      vtkm::cont::arg::TransportTagCellSetIn<VisitTopologyType, IncidentTopologyType>;
    using FetchTag = vtkm::exec::arg::FetchTagCellSetIn;
  };
 
  struct CellShape : vtkm::exec::arg::CellShape
  {
  };
 
  struct IncidentElementCount : vtkm::exec::arg::IncidentElementCount
  {
  };
 
  struct IncidentElementIndices : vtkm::exec::arg::IncidentElementIndices
  {
  };
 
  VTKM_SUPPRESS_EXEC_WARNINGS
  template <typename OutToInArrayType,
            typename VisitArrayType,
            typename ThreadToOutArrayType,
            typename InputDomainType>
  VTKM_EXEC vtkm::exec::arg::ThreadIndicesTopologyMap<InputDomainType,
                                                      vtkm::exec::arg::CustomScatterOrMaskTag>
  GetThreadIndices(vtkm::Id threadIndex,
                   const OutToInArrayType& outToIn,
                   const VisitArrayType& visit,
                   const ThreadToOutArrayType& threadToOut,
                   const InputDomainType& connectivity) const
  {
    const vtkm::Id outIndex = threadToOut.Get(threadIndex);
    return vtkm::exec::arg::ThreadIndicesTopologyMap<InputDomainType,
                                                     vtkm::exec::arg::CustomScatterOrMaskTag>(
      threadIndex, outToIn.Get(outIndex), visit.Get(outIndex), outIndex, connectivity);
  }
 
private:
  static constexpr bool IsScatterIdentity =
    std::is_same<ScatterType, vtkm::worklet::ScatterIdentity>::value;
  static constexpr bool IsMaskNone = std::is_same<MaskType, vtkm::worklet::MaskNone>::value;
 
  template <bool Cond, typename ReturnType>
  using EnableFnWhen = typename std::enable_if<Cond, ReturnType>::type;
 
public:
  VTKM_SUPPRESS_EXEC_WARNINGS
  template <typename OutToInArrayType,
            typename VisitArrayType,
            typename ThreadToOutArrayType,
            typename InputDomainType,
            bool S = IsScatterIdentity,
            bool M = IsMaskNone>
  VTKM_EXEC EnableFnWhen<
    S && M,
    vtkm::exec::arg::ThreadIndicesTopologyMap<InputDomainType,
                                              vtkm::exec::arg::DefaultScatterAndMaskTag>>
  GetThreadIndices(vtkm::Id threadIndex1D,
                   const vtkm::Id3& threadIndex3D,
                   const OutToInArrayType& vtkmNotUsed(outToIn),
                   const VisitArrayType& vtkmNotUsed(visit),
                   const ThreadToOutArrayType& vtkmNotUsed(threadToOut),
                   const InputDomainType& connectivity) const
  {
    return vtkm::exec::arg::ThreadIndicesTopologyMap<InputDomainType,
                                                     vtkm::exec::arg::DefaultScatterAndMaskTag>(
      threadIndex3D, threadIndex1D, connectivity);
  }
 
  VTKM_SUPPRESS_EXEC_WARNINGS
  template <typename OutToInArrayType,
            typename VisitArrayType,
            typename ThreadToOutArrayType,
            typename InputDomainType,
            bool S = IsScatterIdentity,
            bool M = IsMaskNone>
  VTKM_EXEC
    EnableFnWhen<!(S && M),
                 vtkm::exec::arg::ThreadIndicesTopologyMap<InputDomainType,
                                                           vtkm::exec::arg::CustomScatterOrMaskTag>>
    GetThreadIndices(vtkm::Id threadIndex1D,
                     const vtkm::Id3& threadIndex3D,
                     const OutToInArrayType& outToIn,
                     const VisitArrayType& visit,
                     const ThreadToOutArrayType& threadToOut,
                     const InputDomainType& connectivity) const
  {
    const vtkm::Id outIndex = threadToOut.Get(threadIndex1D);
    return vtkm::exec::arg::ThreadIndicesTopologyMap<InputDomainType,
                                                     vtkm::exec::arg::CustomScatterOrMaskTag>(
      threadIndex3D,
      threadIndex1D,
      outToIn.Get(outIndex),
      visit.Get(outIndex),
      outIndex,
      connectivity);
  }
};
 
class WorkletVisitCellsWithPoints
  : public WorkletMapTopology<vtkm::TopologyElementTagCell, vtkm::TopologyElementTagPoint>
{
public:
#ifndef VTKM_DOXYGEN_ONLY
  using FieldInPoint = FieldInIncident;
 
  using FieldInCell = FieldInVisit;
 
  using FieldOutCell = FieldOut;
 
  using FieldInOutCell = FieldInOut;
 
  using PointCount = IncidentElementCount;
 
  using PointIndices = IncidentElementIndices;
#else  // VTKM_DOXYGEN_ONLY
  // These redeclarations of superclass features are for documentation purposes only.
 
 
  struct CellSetIn
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::CellSetIn
  {
  };
 
  struct FieldInCell : FieldInVisit
  {
  };
 
  struct FieldInPoint : FieldInIncident
  {
  };
 
  struct FieldInVisit
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldInVisit
  {
  };
 
  struct FieldInIncident
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldInIncident
  {
  };
 
  struct FieldOutCell : FieldOut
  {
  };
 
  struct FieldOut
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldOut
  {
  };
 
  struct FieldInOutCell : FieldInOut
  {
  };
 
  struct FieldInOut
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldInOut
  {
  };
 
  struct WholeArrayIn : vtkm::worklet::internal::WorkletBase::WholeArrayIn
  {
  };
 
  struct WholeArrayOut : vtkm::worklet::internal::WorkletBase::WholeArrayOut
  {
  };
 
  struct WholeArrayInOut : vtkm::worklet::internal::WorkletBase::WholeArrayInOut
  {
  };
 
  struct AtomicArrayInOut : vtkm::worklet::internal::WorkletBase::AtomicArrayInOut
  {
  };
 
  template <typename VisitTopology = Cell, typename IncidentTopology = Point>
  struct WholeCellSetIn
    : vtkm::worklet::internal::WorkletBase::WholeCellSetIn<VisitTopology, IncidentTopology>
  {
  };
 
  struct ExecObject : vtkm::worklet::internal::WorkletBase::ExecObject
  {
  };
 
 
 
  struct _1 : vtkm::worklet::internal::WorkletBase::_1
  {
  };
 
  struct CellShape
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::CellShape
  {
  };
 
  struct PointCount
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType,
                                        IncidentTopologyType>::IncidentElementCount
  {
  };
 
  struct PointIndices
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType,
                                        IncidentTopologyType>::IncidentElementIndices
  {
  };
 
  struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
  {
  };
 
  struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
  {
  };
 
  struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
  {
  };
 
  struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
  {
  };
 
  struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
  {
  };
 
  struct Device : vtkm::worklet::internal::WorkletBase::Device
  {
  };
 
#endif // VTKM_DOXYGEN_ONLY
};
 
class WorkletVisitPointsWithCells
  : public WorkletMapTopology<vtkm::TopologyElementTagPoint, vtkm::TopologyElementTagCell>
{
public:
#ifndef VTKM_DOXYGEN_ONLY
  using FieldInCell = FieldInIncident;
 
  using FieldInPoint = FieldInVisit;
 
  using FieldOutPoint = FieldOut;
 
  using FieldInOutPoint = FieldInOut;
 
  using CellCount = IncidentElementCount;
 
  using CellIndices = IncidentElementIndices;
#else  // VTKM_DOXYGEN_ONLY
  // These redeclarations of superclass features are for documentation purposes only.
 
 
  struct CellSetIn
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::CellSetIn
  {
  };
 
  struct FieldInPoint : FieldInVisit
  {
  };
 
  struct FieldInCell : FieldInIncident
  {
  };
 
  struct FieldInVisit
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldInVisit
  {
  };
 
  struct FieldInIncident
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldInIncident
  {
  };
 
  struct FieldOutPoint : FieldOut
  {
  };
 
  struct FieldOut
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldOut
  {
  };
 
  struct FieldInOutPoint : FieldInOut
  {
  };
 
  struct FieldInOut
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType, IncidentTopologyType>::FieldInOut
  {
  };
 
  struct WholeArrayIn : vtkm::worklet::internal::WorkletBase::WholeArrayIn
  {
  };
 
  struct WholeArrayOut : vtkm::worklet::internal::WorkletBase::WholeArrayOut
  {
  };
 
  struct WholeArrayInOut : vtkm::worklet::internal::WorkletBase::WholeArrayInOut
  {
  };
 
  struct AtomicArrayInOut : vtkm::worklet::internal::WorkletBase::AtomicArrayInOut
  {
  };
 
  template <typename VisitTopology = Cell, typename IncidentTopology = Point>
  struct WholeCellSetIn
    : vtkm::worklet::internal::WorkletBase::WholeCellSetIn<VisitTopology, IncidentTopology>
  {
  };
 
  struct ExecObject : vtkm::worklet::internal::WorkletBase::ExecObject
  {
  };
 
 
 
  struct _1 : vtkm::worklet::internal::WorkletBase::_1
  {
  };
 
  struct CellCount
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType,
                                        IncidentTopologyType>::IncidentElementCount
  {
  };
 
  struct CellIndices
    : vtkm::worklet::WorkletMapTopology<VisitTopologyType,
                                        IncidentTopologyType>::IncidentElementIndices
  {
  };
 
  struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
  {
  };
 
  struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
  {
  };
 
  struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
  {
  };
 
  struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
  {
  };
 
  struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
  {
  };
 
  struct Device : vtkm::worklet::internal::WorkletBase::Device
  {
  };
 
#endif // VTKM_DOXYGEN_ONLY
};
 
}
} // namespace vtkm::worklet
 
#endif //vtk_m_worklet_WorkletMapTopology_h