vtk-m/vtkm/exec/ConnectivityExplicit.h
2024-07-15 16:04:16 -04:00

104 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.
//============================================================================
#ifndef vtk_m_exec_ConnectivityExplicit_h
#define vtk_m_exec_ConnectivityExplicit_h
#include <vtkm/CellShape.h>
#include <vtkm/Types.h>
#include <vtkm/VecFromPortal.h>
namespace vtkm
{
namespace exec
{
/// @brief A class holding information about topology connections.
///
/// An object of `ConnectivityExplicit` is provided to a worklet when the
/// `ControlSignature` argument is `WholeCellSetIn` and the `vtkm::cont::CellSet`
/// provided is a `vtkm::cont::CellSetExplicit`.
template <typename ShapesPortalType, typename ConnectivityPortalType, typename OffsetsPortalType>
class ConnectivityExplicit
{
public:
using SchedulingRangeType = vtkm::Id;
ConnectivityExplicit() {}
ConnectivityExplicit(const ShapesPortalType& shapesPortal,
const ConnectivityPortalType& connPortal,
const OffsetsPortalType& offsetsPortal)
: Shapes(shapesPortal)
, Connectivity(connPortal)
, Offsets(offsetsPortal)
{
}
/// @brief Provides the number of elements in the topology.
///
/// This number of elements is associated with the "visit" type of topology element,
/// which is the first template argument to `WholeCellSetIn`. The number of elements
/// defines the valid indices for the other methods of this class.
VTKM_EXEC
SchedulingRangeType GetNumberOfElements() const { return this->Shapes.GetNumberOfValues(); }
/// @brief The tag representing the cell shape of the visited elements.
///
/// The tag type is allways `vtkm::CellShapeTagGeneric` and its id is filled with the
/// identifier for the appropriate shape.
using CellShapeTag = vtkm::CellShapeTagGeneric;
/// @brief Returns a tagfor the cell shape associated with the element at the given index.
///
/// The tag type is allways `vtkm::CellShapeTagGeneric` and its id is filled with the
/// identifier for the appropriate shape.
VTKM_EXEC
CellShapeTag GetCellShape(vtkm::Id index) const { return CellShapeTag(this->Shapes.Get(index)); }
/// Given the index of a visited element, returns the number of incident elements
/// touching it.
VTKM_EXEC
vtkm::IdComponent GetNumberOfIndices(vtkm::Id index) const
{
return static_cast<vtkm::IdComponent>(this->Offsets.Get(index + 1) - this->Offsets.Get(index));
}
/// @brief Type of variable that lists of incident indices will be put into.
using IndicesType = vtkm::VecFromPortal<ConnectivityPortalType>;
/// Provides the indices of all elements incident to the visit element of the provided
/// index.
/// Returns a Vec-like object containing the indices for the given index.
/// The object returned is not an actual array, but rather an object that
/// loads the indices lazily out of the connectivity array. This prevents
/// us from having to know the number of indices at compile time.
///
VTKM_EXEC
IndicesType GetIndices(vtkm::Id index) const
{
const vtkm::Id offset = this->Offsets.Get(index);
const vtkm::Id endOffset = this->Offsets.Get(index + 1);
const auto length = static_cast<vtkm::IdComponent>(endOffset - offset);
return IndicesType(this->Connectivity, length, offset);
}
private:
ShapesPortalType Shapes;
ConnectivityPortalType Connectivity;
OffsetsPortalType Offsets;
};
} // namespace exec
} // namespace vtkm
#endif // vtk_m_exec_ConnectivityExplicit_h