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.
232 lines
8.7 KiB
C++
232 lines
8.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 2015 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
|
// Copyright 2015 UT-Battelle, LLC.
|
|
// Copyright 2015 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.
|
|
//
|
|
//=============================================================================
|
|
|
|
#include <vtkm/worklet/ScatterCounting.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/DeviceAdapterAlgorithm.h>
|
|
|
|
#include <vtkm/worklet/DispatcherMapField.h>
|
|
#include <vtkm/worklet/WorkletMapField.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
#include <vector>
|
|
|
|
namespace
|
|
{
|
|
|
|
struct TestScatterArrays
|
|
{
|
|
vtkm::cont::ArrayHandle<vtkm::IdComponent> CountArray;
|
|
vtkm::cont::ArrayHandle<vtkm::Id> InputToOutputMap;
|
|
vtkm::cont::ArrayHandle<vtkm::Id> OutputToInputMap;
|
|
vtkm::cont::ArrayHandle<vtkm::IdComponent> VisitArray;
|
|
};
|
|
|
|
TestScatterArrays MakeScatterArraysShort()
|
|
{
|
|
const vtkm::Id countArraySize = 18;
|
|
const vtkm::IdComponent countArray[countArraySize] = { 1, 2, 0, 0, 1, 0, 1, 0, 0,
|
|
0, 0, 0, 0, 0, 1, 0, 0, 0 };
|
|
const vtkm::Id inputToOutputMap[countArraySize] = { 0, 1, 3, 3, 3, 4, 4, 5, 5,
|
|
5, 5, 5, 5, 5, 5, 6, 6, 6 };
|
|
const vtkm::Id outputSize = 6;
|
|
const vtkm::Id outputToInputMap[outputSize] = { 0, 1, 1, 4, 6, 14 };
|
|
const vtkm::IdComponent visitArray[outputSize] = { 0, 0, 1, 0, 0, 0 };
|
|
|
|
TestScatterArrays arrays;
|
|
using Algorithm = vtkm::cont::DeviceAdapterAlgorithm<VTKM_DEFAULT_DEVICE_ADAPTER_TAG>;
|
|
|
|
// Need to copy arrays so that the data does not go out of scope.
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(countArray, countArraySize), arrays.CountArray);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(inputToOutputMap, countArraySize),
|
|
arrays.InputToOutputMap);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(outputToInputMap, outputSize),
|
|
arrays.OutputToInputMap);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(visitArray, outputSize), arrays.VisitArray);
|
|
|
|
return arrays;
|
|
}
|
|
|
|
TestScatterArrays MakeScatterArraysLong()
|
|
{
|
|
const vtkm::Id countArraySize = 6;
|
|
const vtkm::IdComponent countArray[countArraySize] = { 0, 1, 2, 3, 4, 5 };
|
|
const vtkm::Id inputToOutputMap[countArraySize] = { 0, 0, 1, 3, 6, 10 };
|
|
const vtkm::Id outputSize = 15;
|
|
const vtkm::Id outputToInputMap[outputSize] = { 1, 2, 2, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 5 };
|
|
const vtkm::IdComponent visitArray[outputSize] = { 0, 0, 1, 0, 1, 2, 0, 1, 2, 3, 0, 1, 2, 3, 4 };
|
|
|
|
TestScatterArrays arrays;
|
|
using Algorithm = vtkm::cont::DeviceAdapterAlgorithm<VTKM_DEFAULT_DEVICE_ADAPTER_TAG>;
|
|
|
|
// Need to copy arrays so that the data does not go out of scope.
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(countArray, countArraySize), arrays.CountArray);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(inputToOutputMap, countArraySize),
|
|
arrays.InputToOutputMap);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(outputToInputMap, outputSize),
|
|
arrays.OutputToInputMap);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(visitArray, outputSize), arrays.VisitArray);
|
|
|
|
return arrays;
|
|
}
|
|
|
|
TestScatterArrays MakeScatterArraysZero()
|
|
{
|
|
const vtkm::Id countArraySize = 6;
|
|
const vtkm::IdComponent countArray[countArraySize] = { 0, 0, 0, 0, 0, 0 };
|
|
const vtkm::Id inputToOutputMap[countArraySize] = { 0, 0, 0, 0, 0, 0 };
|
|
|
|
TestScatterArrays arrays;
|
|
using Algorithm = vtkm::cont::DeviceAdapterAlgorithm<VTKM_DEFAULT_DEVICE_ADAPTER_TAG>;
|
|
|
|
// Need to copy arrays so that the data does not go out of scope.
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(countArray, countArraySize), arrays.CountArray);
|
|
Algorithm::Copy(vtkm::cont::make_ArrayHandle(inputToOutputMap, countArraySize),
|
|
arrays.InputToOutputMap);
|
|
arrays.OutputToInputMap.Allocate(0);
|
|
arrays.VisitArray.Allocate(0);
|
|
|
|
return arrays;
|
|
}
|
|
|
|
struct TestScatterCountingWorklet : public vtkm::worklet::WorkletMapField
|
|
{
|
|
typedef void ControlSignature(FieldIn<> inputIndices,
|
|
FieldOut<> copyIndices,
|
|
FieldOut<> recordVisit,
|
|
FieldOut<> recordWorkId);
|
|
typedef void ExecutionSignature(_1, _2, _3, _4, VisitIndex, WorkIndex);
|
|
|
|
using ScatterType = vtkm::worklet::ScatterCounting;
|
|
|
|
template <typename CountArrayType, typename Device>
|
|
VTKM_CONT static ScatterType MakeScatter(const CountArrayType& countArray, Device)
|
|
{
|
|
return ScatterType(countArray, Device());
|
|
}
|
|
|
|
VTKM_EXEC
|
|
void operator()(vtkm::Id inputIndex,
|
|
vtkm::Id& indexCopy,
|
|
vtkm::IdComponent& writeVisit,
|
|
vtkm::Float32& captureWorkId,
|
|
vtkm::IdComponent visitIndex,
|
|
vtkm::Id workId) const
|
|
{
|
|
indexCopy = inputIndex;
|
|
writeVisit = visitIndex;
|
|
captureWorkId = TestValue(workId, vtkm::Float32());
|
|
}
|
|
};
|
|
|
|
template <typename T>
|
|
void CompareArrays(vtkm::cont::ArrayHandle<T> array1, vtkm::cont::ArrayHandle<T> array2)
|
|
{
|
|
using PortalType = typename vtkm::cont::ArrayHandle<T>::PortalConstControl;
|
|
PortalType portal1 = array1.GetPortalConstControl();
|
|
PortalType portal2 = array2.GetPortalConstControl();
|
|
|
|
VTKM_TEST_ASSERT(portal1.GetNumberOfValues() == portal2.GetNumberOfValues(),
|
|
"Arrays are not the same length.");
|
|
|
|
for (vtkm::Id index = 0; index < portal1.GetNumberOfValues(); index++)
|
|
{
|
|
T value1 = portal1.Get(index);
|
|
T value2 = portal2.Get(index);
|
|
VTKM_TEST_ASSERT(value1 == value2, "Array values not equal.");
|
|
}
|
|
}
|
|
|
|
// This unit test makes sure the ScatterCounting generates the correct map
|
|
// and visit arrays.
|
|
void TestScatterArrayGeneration(const TestScatterArrays& arrays)
|
|
{
|
|
std::cout << " Testing array generation" << std::endl;
|
|
|
|
vtkm::worklet::ScatterCounting scatter(
|
|
arrays.CountArray, VTKM_DEFAULT_DEVICE_ADAPTER_TAG(), true);
|
|
|
|
vtkm::Id inputSize = arrays.CountArray.GetNumberOfValues();
|
|
|
|
std::cout << " Checking input to output map." << std::endl;
|
|
CompareArrays(arrays.InputToOutputMap, scatter.GetInputToOutputMap());
|
|
|
|
std::cout << " Checking output to input map." << std::endl;
|
|
CompareArrays(arrays.OutputToInputMap, scatter.GetOutputToInputMap(inputSize));
|
|
|
|
std::cout << " Checking visit array." << std::endl;
|
|
CompareArrays(arrays.VisitArray, scatter.GetVisitArray(inputSize));
|
|
}
|
|
|
|
// This is more of an integration test that makes sure the scatter works with a
|
|
// worklet invocation.
|
|
void TestScatterWorklet(const TestScatterArrays& arrays)
|
|
{
|
|
std::cout << " Testing scatter counting in a worklet." << std::endl;
|
|
|
|
vtkm::worklet::DispatcherMapField<TestScatterCountingWorklet> dispatcher(
|
|
TestScatterCountingWorklet::MakeScatter(arrays.CountArray, VTKM_DEFAULT_DEVICE_ADAPTER_TAG()));
|
|
|
|
vtkm::Id inputSize = arrays.CountArray.GetNumberOfValues();
|
|
vtkm::cont::ArrayHandleIndex inputIndices(inputSize);
|
|
vtkm::cont::ArrayHandle<vtkm::Id> outputToInputMapCopy;
|
|
vtkm::cont::ArrayHandle<vtkm::IdComponent> visitCopy;
|
|
vtkm::cont::ArrayHandle<vtkm::Float32> captureWorkId;
|
|
|
|
std::cout << " Invoke worklet" << std::endl;
|
|
dispatcher.Invoke(inputIndices, outputToInputMapCopy, visitCopy, captureWorkId);
|
|
|
|
std::cout << " Check output to input map." << std::endl;
|
|
CompareArrays(outputToInputMapCopy, arrays.OutputToInputMap);
|
|
std::cout << " Check visit." << std::endl;
|
|
CompareArrays(visitCopy, arrays.VisitArray);
|
|
std::cout << " Check work id." << std::endl;
|
|
CheckPortal(captureWorkId.GetPortalConstControl());
|
|
}
|
|
|
|
void TestScatterCountingWithArrays(const TestScatterArrays& arrays)
|
|
{
|
|
TestScatterArrayGeneration(arrays);
|
|
TestScatterWorklet(arrays);
|
|
}
|
|
|
|
void TestScatterCounting()
|
|
{
|
|
std::cout << "Testing arrays with output smaller than input." << std::endl;
|
|
TestScatterCountingWithArrays(MakeScatterArraysShort());
|
|
|
|
std::cout << "Testing arrays with output larger than input." << std::endl;
|
|
TestScatterCountingWithArrays(MakeScatterArraysLong());
|
|
|
|
std::cout << "Testing arrays with zero output." << std::endl;
|
|
TestScatterCountingWithArrays(MakeScatterArraysZero());
|
|
}
|
|
|
|
} // anonymous namespace
|
|
|
|
int UnitTestScatterCounting(int, char* [])
|
|
{
|
|
return vtkm::cont::testing::Testing::Run(TestScatterCounting);
|
|
}
|