Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-10-05 09:59:12 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity
27ee972371
vtk-m/vtkm/worklet/WorkletPointNeighborhood.h

236 lines
8.5 KiB
C
Raw Normal View History

Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
//============================================================================
// Copyright (c) Kitware, Inc.
// All rights reserved.
// See LICENSE.txt for details.
conslidate the license statement
2019-04-15 23:24:21 +00:00
//
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
// 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.
//============================================================================
GhostCellClassify now more efficient as it uses WorkletPointNeighborhood By using the dual of the cellset we can quickly compute the GhostCells of structured data using WorkletPointNeighborhood boundary condition object Using a 1024x1024x512 test grid we see the following perf: Master Serial : 5.658144 sec This MR Serial: 0.519684 sec Master OpenMP : 0.532256 sec This MR OpenMP: 0.080604 sec
2019-09-10 19:00:53 +00:00
#ifndef vtk_m_worklet_WorkletPointNeighborhood_h
#define vtk_m_worklet_WorkletPointNeighborhood_h
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
/// \brief Worklet for volume algorithms that require a neighborhood
///
/// WorkletPointNeighborhood executes on every point inside a volume providing
/// access to the 3D neighborhood values. The neighborhood is always cubic in
/// nature and is fixed at compile time.
#include <vtkm/exec/arg/ThreadIndicesPointNeighborhood.h>
Reverse Invoker, Dispatcher and Worklet dependency
2020-07-21 21:06:37 +00:00
#include <vtkm/worklet/DispatcherPointNeighborhood.h>
Extract WorkletNeighborhood base class
2020-07-20 23:50:14 +00:00
#include <vtkm/worklet/WorkletNeighborhood.h>
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
namespace vtkm
{
namespace worklet
{
Add reference documentation for Worklet types
2024-01-12 19:58:07 +00:00
/// @brief Base class for worklets that map over the points in a structured grid with neighborhood information.
///
/// The domain of a `WorkletPointNeighborhood` is a `vtkm::cont::CellSetStructured`. It visits
/// all the points in the mesh and provides access to the point field values of the visited point
/// and the field values of the nearby connected neighborhood of a prescribed size.
Extract WorkletNeighborhood base class
2020-07-20 23:50:14 +00:00
class WorkletPointNeighborhood : public WorkletNeighborhood
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
{
public:
Add an easier way to launch vtkm worklets
2018-08-29 13:30:27 +00:00
template <typename Worklet>
using Dispatcher = vtkm::worklet::DispatcherPointNeighborhood<Worklet>;
Add reference documentation for Worklet types
2024-01-12 19:58:07 +00:00
/// @defgroup WorkletPointNeighborhoodControlSigTags `ControlSignature` tags
/// Tags that can be used in the `ControlSignature` of a `WorkletPointNeighborhood`.
/// @{
#ifdef VTKM_DOXYGEN_ONLY
// These redeclarations of superclass features are for documentation purposes only.
/// @copydoc vtkm::worklet::WorkletNeighborhood::CellSetIn
struct CellSetIn : vtkm::worklet::WorkletNeighborhood::CellSetIn
{
};
/// @copydoc vtkm::worklet::WorkletNeighborhood::FieldIn
struct FieldIn : vtkm::worklet::WorkletNeighborhood::FieldIn
{
};
/// @copydoc vtkm::worklet::WorkletNeighborhood::FieldInNeighborhood
struct FieldInNeighborhood : vtkm::worklet::WorkletNeighborhood::FieldInNeighborhood
{
};
/// @copydoc vtkm::worklet::WorkletNeighborhood::FieldOut
struct FieldOut : vtkm::worklet::WorkletNeighborhood::FieldOut
{
};
/// @copydoc vtkm::worklet::WorkletNeighborhood::FieldInOut
struct FieldInOut : vtkm::worklet::WorkletNeighborhood::FieldInOut
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WholeArrayIn
struct WholeArrayIn : vtkm::worklet::internal::WorkletBase::WholeArrayIn
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WholeArrayOut
struct WholeArrayOut : vtkm::worklet::internal::WorkletBase::WholeArrayOut
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WholeArrayInOut
struct WholeArrayInOut : vtkm::worklet::internal::WorkletBase::WholeArrayInOut
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::AtomicArrayInOut
struct AtomicArrayInOut : vtkm::worklet::internal::WorkletBase::AtomicArrayInOut
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WholeCellSetIn
template <typename VisitTopology = Cell, typename IncidentTopology = Point>
struct WholeCellSetIn
: vtkm::worklet::internal::WorkletBase::WholeCellSetIn<VisitTopology, IncidentTopology>
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ExecObject
struct ExecObject : vtkm::worklet::internal::WorkletBase::ExecObject
{
};
#endif // VTKM_DOXYGEN_ONLY
/// @}
/// @defgroup WorkletPointNeighborhoodExecutionSigTags `ExecutionSignature` tags
/// Tags that can be used in the `ExecutionSignature` of a `WorkletPointNeighborhood`.
/// @{
#ifdef VTKM_DOXYGEN_ONLY
// These redeclarations of superclass features are for documentation purposes only.
/// @copydoc vtkm::placeholders::Arg
struct _1 : vtkm::worklet::internal::WorkletBase::_1
{
};
/// @copydoc vtkm::worklet::WorkletNeighborhood::Boundary
struct Boundary : vtkm::worklet::WorkletNeighborhood::Boundary
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::Device
struct Device : vtkm::worklet::internal::WorkletBase::Device
{
};
#endif // VTKM_DOXYGEN_ONLY
/// @}
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
/// Point neighborhood worklets use the related thread indices class.
///
VTKM_SUPPRESS_EXEC_WARNINGS
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
template <typename OutToInArrayType,
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
typename VisitArrayType,
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
typename ThreadToOutArrayType,
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
vtkm::IdComponent Dimension>
Change WorkletPointNeighborhood to specify neighborhood at runtime Previously, WorkletPointNeighborhood had a template argument to select the size of the neighborhood. This change removes that template argument. Instead, the vtkm::exec::arg::BoundaryState methods now take in a size parameter when determining when it overlaps the boundary. If in the future we want to add the ability to select the neighborhood size at compile-time (for performance reasons), I suggest adding this template argument to the OnBoundary tag for ExecutionSignature.
2018-11-18 17:41:13 +00:00
VTKM_EXEC vtkm::exec::arg::ThreadIndicesPointNeighborhood GetThreadIndices(
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
vtkm::Id threadIndex,
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
const OutToInArrayType& outToIn,
const VisitArrayType& visit,
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
const ThreadToOutArrayType& threadToOut,
Refactor topology mappings to clarify meaning. The `From` and `To` nomenclature for topology mapping has been confusing for both users and developers, especially at lower levels where the intention of mapping attributes from one element to another is easily conflated with the concept of mapping indices (which maps in the exact opposite direction). These identifiers have been renamed to `VisitTopology` and `IncidentTopology` to clarify the direction of the mapping. The order in which these template parameters are specified for `WorkletMapTopology` have also been reversed, since eventually there may be more than one `IncidentTopology`, and having `IncidentTopology` at the end will allow us to replace it with a variadic template parameter pack in the future. Other implementation details supporting these worklets, include `Fetch` tags, `Connectivity` classes, and methods on the various `CellSet` classes (such as `PrepareForInput` have also reversed their template arguments. These will need to be cautiously updated. The convenience implementations of `WorkletMapTopology` have been renamed for clarity as follows: ``` WorkletMapPointToCell --> WorkletVisitCellsWithPoints WorkletMapCellToPoint --> WorkletVisitPointsWithCells ``` The `ControlSignature` tags have been renamed as follows: ``` FieldInTo --> FieldInVisit FieldInFrom --> FieldInMap FromCount --> IncidentElementCount FromIndices --> IncidentElementIndices ```
2019-07-30 16:53:51 +00:00
const vtkm::exec::ConnectivityStructured<vtkm::TopologyElementTagPoint,
vtkm::TopologyElementTagCell,
Remove ArrayHandleStreaming capabilities The `ArrayHandleStreaming` class stems from an old research project experimenting with bringing data from an `ArrayHandle` in parts and overlapping device transfer and execution. It works, but only in very limited contexts. Thus, it is not actually used today. Plus, the feature requires global indexing to be permutated throughout the worklet dispatching classes of VTK-m for no further reason. Because it is not really used, there are other more promising approaches on the horizon, and it makes further scheduling improvements difficult, we are removing this functionality.
2020-03-23 20:27:00 +00:00
Dimension>& inputDomain //this should be explicit
clang-format: reformat the repository with clang-format-9
2020-08-17 14:18:24 +00:00
) const
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
{
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
const vtkm::Id outIndex = threadToOut.Get(threadIndex);
Remove ArrayHandleStreaming capabilities The `ArrayHandleStreaming` class stems from an old research project experimenting with bringing data from an `ArrayHandle` in parts and overlapping device transfer and execution. It works, but only in very limited contexts. Thus, it is not actually used today. Plus, the feature requires global indexing to be permutated throughout the worklet dispatching classes of VTK-m for no further reason. Because it is not really used, there are other more promising approaches on the horizon, and it makes further scheduling improvements difficult, we are removing this functionality.
2020-03-23 20:27:00 +00:00
return vtkm::exec::arg::ThreadIndicesPointNeighborhood(
threadIndex, outToIn.Get(outIndex), visit.Get(outIndex), outIndex, inputDomain);
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
}
Worklet{MapTopology,PointNeighbor} custom sg/mask The change affects the method GetThreadIndices for both WorkletMapTopology and WorkletPointNeighborhood. Before an scatter or mask which was not ScatterIdentity or MaskNone was not allowed and it was enforced at compilation time. Signed-off-by: Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>
2020-03-12 15:49:10 +00:00
/// In the remaining methods and `constexpr` we determine at compilation time
/// which method definition will be actually used for GetThreadIndices.
///
/// We want to avoid further function calls when we use WorkletMapTopology in which
/// ScatterType is set as ScatterIdentity and MaskType as MaskNone.
/// Otherwise, we call the default method defined at the bottom of this class.
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;
public:
template <bool Cond, typename ReturnType>
using EnableFnWhen = typename std::enable_if<Cond, ReturnType>::type;
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
VTKM_SUPPRESS_EXEC_WARNINGS
template <typename OutToInArrayType,
typename VisitArrayType,
typename ThreadToOutArrayType,
Worklet{MapTopology,PointNeighbor} custom sg/mask The change affects the method GetThreadIndices for both WorkletMapTopology and WorkletPointNeighborhood. Before an scatter or mask which was not ScatterIdentity or MaskNone was not allowed and it was enforced at compilation time. Signed-off-by: Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>
2020-03-12 15:49:10 +00:00
typename InputDomainType,
bool S = IsScatterIdentity,
bool M = IsMaskNone>
VTKM_EXEC EnableFnWhen<S && M, vtkm::exec::arg::ThreadIndicesPointNeighborhood> GetThreadIndices(
Initial infrastructure to allow WorkletMapField to have 3D scheduling
2020-01-06 22:06:51 +00:00
vtkm::Id threadIndex1D,
const vtkm::Id3& threadIndex3D,
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
const OutToInArrayType& vtkmNotUsed(outToIn),
const VisitArrayType& vtkmNotUsed(visit),
const ThreadToOutArrayType& vtkmNotUsed(threadToOut),
Remove ArrayHandleStreaming capabilities The `ArrayHandleStreaming` class stems from an old research project experimenting with bringing data from an `ArrayHandle` in parts and overlapping device transfer and execution. It works, but only in very limited contexts. Thus, it is not actually used today. Plus, the feature requires global indexing to be permutated throughout the worklet dispatching classes of VTK-m for no further reason. Because it is not really used, there are other more promising approaches on the horizon, and it makes further scheduling improvements difficult, we are removing this functionality.
2020-03-23 20:27:00 +00:00
const InputDomainType& connectivity) const
Add Mask capabilities to worklets Mask objects allow you to specify which output values should be generated when a worklet is run. That is, the Mask allows you to skip the invocation of a worklet for any number of outputs.
2019-01-21 02:14:55 +00:00
{
Change WorkletPointNeighborhood to specify neighborhood at runtime Previously, WorkletPointNeighborhood had a template argument to select the size of the neighborhood. This change removes that template argument. Instead, the vtkm::exec::arg::BoundaryState methods now take in a size parameter when determining when it overlaps the boundary. If in the future we want to add the ability to select the neighborhood size at compile-time (for performance reasons), I suggest adding this template argument to the OnBoundary tag for ExecutionSignature.
2018-11-18 17:41:13 +00:00
return vtkm::exec::arg::ThreadIndicesPointNeighborhood(
Remove ArrayHandleStreaming capabilities The `ArrayHandleStreaming` class stems from an old research project experimenting with bringing data from an `ArrayHandle` in parts and overlapping device transfer and execution. It works, but only in very limited contexts. Thus, it is not actually used today. Plus, the feature requires global indexing to be permutated throughout the worklet dispatching classes of VTK-m for no further reason. Because it is not really used, there are other more promising approaches on the horizon, and it makes further scheduling improvements difficult, we are removing this functionality.
2020-03-23 20:27:00 +00:00
threadIndex3D, threadIndex1D, connectivity);
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
}
Worklet{MapTopology,PointNeighbor} custom sg/mask The change affects the method GetThreadIndices for both WorkletMapTopology and WorkletPointNeighborhood. Before an scatter or mask which was not ScatterIdentity or MaskNone was not allowed and it was enforced at compilation time. Signed-off-by: Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>
2020-03-12 15:49:10 +00:00
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::ThreadIndicesPointNeighborhood>
GetThreadIndices(vtkm::Id threadIndex1D,
const vtkm::Id3& threadIndex3D,
const OutToInArrayType& outToIn,
const VisitArrayType& visit,
const ThreadToOutArrayType& threadToOut,
Remove ArrayHandleStreaming capabilities The `ArrayHandleStreaming` class stems from an old research project experimenting with bringing data from an `ArrayHandle` in parts and overlapping device transfer and execution. It works, but only in very limited contexts. Thus, it is not actually used today. Plus, the feature requires global indexing to be permutated throughout the worklet dispatching classes of VTK-m for no further reason. Because it is not really used, there are other more promising approaches on the horizon, and it makes further scheduling improvements difficult, we are removing this functionality.
2020-03-23 20:27:00 +00:00
const InputDomainType& connectivity) const
Worklet{MapTopology,PointNeighbor} custom sg/mask The change affects the method GetThreadIndices for both WorkletMapTopology and WorkletPointNeighborhood. Before an scatter or mask which was not ScatterIdentity or MaskNone was not allowed and it was enforced at compilation time. Signed-off-by: Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>
2020-03-12 15:49:10 +00:00
{
const vtkm::Id outIndex = threadToOut.Get(threadIndex1D);
return vtkm::exec::arg::ThreadIndicesPointNeighborhood(threadIndex3D,
threadIndex1D,
outToIn.Get(outIndex),
visit.Get(outIndex),
outIndex,
Remove ArrayHandleStreaming capabilities The `ArrayHandleStreaming` class stems from an old research project experimenting with bringing data from an `ArrayHandle` in parts and overlapping device transfer and execution. It works, but only in very limited contexts. Thus, it is not actually used today. Plus, the feature requires global indexing to be permutated throughout the worklet dispatching classes of VTK-m for no further reason. Because it is not really used, there are other more promising approaches on the horizon, and it makes further scheduling improvements difficult, we are removing this functionality.
2020-03-23 20:27:00 +00:00
connectivity);
Worklet{MapTopology,PointNeighbor} custom sg/mask The change affects the method GetThreadIndices for both WorkletMapTopology and WorkletPointNeighborhood. Before an scatter or mask which was not ScatterIdentity or MaskNone was not allowed and it was enforced at compilation time. Signed-off-by: Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>
2020-03-12 15:49:10 +00:00
}
Adds WorkletPointNeighborhood and DispatcherPointNeighborhood types. VTK-m is now able to run algorithms on structured points that require the local point neighbors in a highly efficient manner.
2017-07-11 12:33:56 +00:00
};
}
}
#endif
Reference in New Issue Copy Permalink