mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-20 02:55:47 +00:00
edc4c85fd9
Previously, when a Worklet needed a scatter, the scatter object was stored in the Worklet object. That was problematic because that means the Scatter, which is a control object, was shoved into the execution environment. To prevent that, move the Scatter into the Dispatcher object. The worklet still declares a ScatterType alias, but no longer has a GetScatter method. Instead, the Dispatcher now takes a Scatter object in its constructor. If using the default scatter (ScatterIdentity), the default constructor is used. If using another type of Scatter that requires data to set up its state, then the caller of the worklet needs to provide that to the dispatcher. For convenience, worklets are encouraged to have a MakeScatter method to help construct a proper scatter object.
92 lines
3.7 KiB
C++
92 lines
3.7 KiB
C++
//============================================================================
|
|
// 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 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-NA0003525 with NTESS,
|
|
// 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_worklet_DispatcherPointNeighborhood_h
|
|
#define vtk_m_worklet_DispatcherPointNeighborhood_h
|
|
|
|
#include <vtkm/cont/DeviceAdapter.h>
|
|
|
|
#include <vtkm/worklet/WorkletPointNeighborhood.h>
|
|
|
|
#include <vtkm/worklet/internal/DispatcherBase.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace worklet
|
|
{
|
|
|
|
/// \brief Dispatcher for worklets that inherit from \c WorkletPointNeighborhood.
|
|
///
|
|
template <typename WorkletType, typename Device = VTKM_DEFAULT_DEVICE_ADAPTER_TAG>
|
|
class DispatcherPointNeighborhood
|
|
: public vtkm::worklet::internal::DispatcherBase<DispatcherPointNeighborhood<WorkletType, Device>,
|
|
WorkletType,
|
|
vtkm::worklet::WorkletPointNeighborhoodBase>
|
|
{
|
|
using Superclass =
|
|
vtkm::worklet::internal::DispatcherBase<DispatcherPointNeighborhood<WorkletType, Device>,
|
|
WorkletType,
|
|
vtkm::worklet::WorkletPointNeighborhoodBase>;
|
|
using ScatterType = typename Superclass::ScatterType;
|
|
|
|
public:
|
|
// If you get a compile error here about there being no appropriate constructor for ScatterType,
|
|
// then that probably means that the worklet you are trying to execute has defined a custom
|
|
// ScatterType and that you need to create one (because there is no default way to construct
|
|
// the scatter). By convention, worklets that define a custom scatter type usually provide a
|
|
// static method named MakeScatter that constructs a scatter object.
|
|
VTKM_CONT
|
|
DispatcherPointNeighborhood(const WorkletType& worklet = WorkletType(),
|
|
const ScatterType& scatter = ScatterType())
|
|
: Superclass(worklet, scatter)
|
|
{
|
|
}
|
|
|
|
VTKM_CONT
|
|
DispatcherPointNeighborhood(const ScatterType& scatter)
|
|
: Superclass(WorkletType(), scatter)
|
|
{
|
|
}
|
|
|
|
template <typename Invocation>
|
|
void DoInvoke(const Invocation& invocation) const
|
|
{
|
|
// This is the type for the input domain
|
|
using InputDomainType = typename Invocation::InputDomainType;
|
|
|
|
// If you get a compile error on this line, then you have tried to use
|
|
// something that is not a vtkm::cont::CellSet as the input domain to a
|
|
// topology operation (that operates on a cell set connection domain).
|
|
VTKM_IS_CELL_SET(InputDomainType);
|
|
|
|
// We can pull the input domain parameter (the data specifying the input
|
|
// domain) from the invocation object.
|
|
const InputDomainType& inputDomain = invocation.GetInputDomain();
|
|
auto inputRange = inputDomain.GetSchedulingRange(vtkm::TopologyElementTagPoint());
|
|
|
|
// This is pretty straightforward dispatch. Once we know the number
|
|
// of invocations, the superclass can take care of the rest.
|
|
this->BasicInvoke(invocation, inputRange, Device());
|
|
}
|
|
};
|
|
}
|
|
} // namespace vtkm::worklet
|
|
|
|
#endif //vtk_m_worklet_DispatcherPointNeighborhood_h
|