WorkletBase.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_worklet_internal_WorkletBase_h
#define viskores_worklet_internal_WorkletBase_h
 
#include <viskores/TopologyElementTag.h>
 
#include <viskores/exec/FunctorBase.h>
#include <viskores/exec/arg/BasicArg.h>
#include <viskores/exec/arg/FetchTagExecObject.h>
#include <viskores/exec/arg/FetchTagWholeCellSetIn.h>
#include <viskores/exec/arg/InputIndex.h>
#include <viskores/exec/arg/OutputIndex.h>
#include <viskores/exec/arg/ThreadIndices.h>
#include <viskores/exec/arg/ThreadIndicesBasic.h>
#include <viskores/exec/arg/ThreadIndicesBasic3D.h>
#include <viskores/exec/arg/VisitIndex.h>
#include <viskores/exec/arg/WorkIndex.h>
 
#include <viskores/cont/arg/ControlSignatureTagBase.h>
#include <viskores/cont/arg/TransportTagAtomicArray.h>
#include <viskores/cont/arg/TransportTagBitField.h>
#include <viskores/cont/arg/TransportTagCellSetIn.h>
#include <viskores/cont/arg/TransportTagExecObject.h>
#include <viskores/cont/arg/TransportTagWholeArrayIn.h>
#include <viskores/cont/arg/TransportTagWholeArrayInOut.h>
#include <viskores/cont/arg/TransportTagWholeArrayOut.h>
#include <viskores/cont/arg/TypeCheckTagArrayIn.h>
#include <viskores/cont/arg/TypeCheckTagArrayInOut.h>
#include <viskores/cont/arg/TypeCheckTagArrayOut.h>
#include <viskores/cont/arg/TypeCheckTagAtomicArray.h>
#include <viskores/cont/arg/TypeCheckTagBitField.h>
#include <viskores/cont/arg/TypeCheckTagCellSet.h>
#include <viskores/cont/arg/TypeCheckTagExecObject.h>
 
#include <viskores/cont/internal/Hints.h>
 
#include <viskores/worklet/MaskNone.h>
#include <viskores/worklet/ScatterIdentity.h>
#include <viskores/worklet/internal/Placeholders.h>
 
namespace viskores
{
namespace worklet
{
namespace internal
{
 
class VISKORES_ALWAYS_EXPORT WorkletBase : public viskores::exec::FunctorBase
{
public:
  using _1 = viskores::placeholders::Arg<1>;
  using _2 = viskores::placeholders::Arg<2>;
  using _3 = viskores::placeholders::Arg<3>;
  using _4 = viskores::placeholders::Arg<4>;
  using _5 = viskores::placeholders::Arg<5>;
  using _6 = viskores::placeholders::Arg<6>;
  using _7 = viskores::placeholders::Arg<7>;
  using _8 = viskores::placeholders::Arg<8>;
  using _9 = viskores::placeholders::Arg<9>;
  using _10 = viskores::placeholders::Arg<10>;
  using _11 = viskores::placeholders::Arg<11>;
  using _12 = viskores::placeholders::Arg<12>;
  using _13 = viskores::placeholders::Arg<13>;
  using _14 = viskores::placeholders::Arg<14>;
  using _15 = viskores::placeholders::Arg<15>;
  using _16 = viskores::placeholders::Arg<16>;
  using _17 = viskores::placeholders::Arg<17>;
  using _18 = viskores::placeholders::Arg<18>;
  using _19 = viskores::placeholders::Arg<19>;
  using _20 = viskores::placeholders::Arg<20>;
 
  using WorkIndex = viskores::exec::arg::WorkIndex;
 
  using InputIndex = viskores::exec::arg::InputIndex;
 
  using OutputIndex = viskores::exec::arg::OutputIndex;
 
  using ThreadIndices = viskores::exec::arg::ThreadIndices;
 
  using VisitIndex = viskores::exec::arg::VisitIndex;
 
  struct Device : viskores::exec::arg::ExecutionSignatureTagBase
  {
    // INDEX 0 (which is an invalid parameter index) is reserved to mean the device adapter tag.
    static constexpr viskores::IdComponent INDEX = 0;
    using AspectTag = viskores::exec::arg::AspectTagDefault;
  };
 
  struct ExecObject : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagExecObject;
    using TransportTag = viskores::cont::arg::TransportTagExecObject;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
 
  using InputDomain = _1;
 
  using ScatterType = viskores::worklet::ScatterIdentity;
 
  using MaskType = viskores::worklet::MaskNone;
 
  using Hints = viskores::cont::internal::HintList<>;
 
  struct WholeArrayIn : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayIn;
    using TransportTag = viskores::cont::arg::TransportTagWholeArrayIn;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
 
  struct WholeArrayOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayOut;
    using TransportTag = viskores::cont::arg::TransportTagWholeArrayOut;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
 
  struct WholeArrayInOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayInOut;
    using TransportTag = viskores::cont::arg::TransportTagWholeArrayInOut;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
 
  struct AtomicArrayInOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagAtomicArray;
    using TransportTag = viskores::cont::arg::TransportTagAtomicArray;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
 
  struct BitFieldIn : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagBitField;
    using TransportTag = viskores::cont::arg::TransportTagBitFieldIn;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
  struct BitFieldOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagBitField;
    using TransportTag = viskores::cont::arg::TransportTagBitFieldOut;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
  struct BitFieldInOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagBitField;
    using TransportTag = viskores::cont::arg::TransportTagBitFieldInOut;
    using FetchTag = viskores::exec::arg::FetchTagExecObject;
  };
 
  using Point = viskores::TopologyElementTagPoint;
  using Cell = viskores::TopologyElementTagCell;
  using Edge = viskores::TopologyElementTagEdge;
  using Face = viskores::TopologyElementTagFace;
 
  template <typename VisitTopology = Cell, typename IncidentTopology = Point>
  struct WholeCellSetIn : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagCellSet;
    using TransportTag =
      viskores::cont::arg::TransportTagCellSetIn<VisitTopology, IncidentTopology>;
    using FetchTag = viskores::exec::arg::FetchTagWholeCellSetIn;
  };
 
  VISKORES_SUPPRESS_EXEC_WARNINGS
  template <typename OutToInArrayType,
            typename VisitArrayType,
            typename ThreadToOutArrayType,
            typename InputDomainType>
  VISKORES_EXEC viskores::exec::arg::ThreadIndicesBasic GetThreadIndices(
    const viskores::Id& threadIndex,
    const OutToInArrayType& outToIn,
    const VisitArrayType& visit,
    const ThreadToOutArrayType& threadToOut,
    const InputDomainType&) const
  {
    viskores::Id outIndex = threadToOut.Get(threadIndex);
    return viskores::exec::arg::ThreadIndicesBasic(
      threadIndex, outToIn.Get(outIndex), visit.Get(outIndex), outIndex);
  }
 
  VISKORES_SUPPRESS_EXEC_WARNINGS
  template <typename OutToInArrayType,
            typename VisitArrayType,
            typename ThreadToOutArrayType,
            typename InputDomainType>
  VISKORES_EXEC viskores::exec::arg::ThreadIndicesBasic3D GetThreadIndices(
    viskores::Id threadIndex1D,
    const viskores::Id3& threadIndex3D,
    const OutToInArrayType& outToIn,
    const VisitArrayType& visit,
    const ThreadToOutArrayType& threadToOut,
    const InputDomainType&) const
  {
    viskores::Id outIndex = threadToOut.Get(threadIndex1D);
    return viskores::exec::arg::ThreadIndicesBasic3D(
      threadIndex3D, threadIndex1D, outToIn.Get(outIndex), visit.Get(outIndex), outIndex);
  }
};
}
}
} // namespace viskores::worklet::internal
 
#endif //viskores_worklet_internal_WorkletBase_h