vtk-m/vtkm/worklet/SplitSharpEdges.h
Kenneth Moreland 51e817adc1 Introduce vtkm::ErrorCode
This is a flag that functions in the execution environment can return to
report on the status of the operation. This way they can report an error
without forcing the entire invocation to shut down.
2020-03-13 18:58:33 -06:00

526 lines
22 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_worklet_SplitSharpEdges_h
#define vtk_m_worklet_SplitSharpEdges_h
#include <vtkm/worklet/CellDeepCopy.h>
#include <vtkm/cont/Algorithm.h>
#include <vtkm/cont/ArrayCopy.h>
#include <vtkm/cont/ArrayHandleCounting.h>
#include <vtkm/cont/ArrayHandlePermutation.h>
#include <vtkm/cont/Invoker.h>
#include <vtkm/exec/CellEdge.h>
#include <vtkm/Bitset.h>
#include <vtkm/CellTraits.h>
#include <vtkm/TypeTraits.h>
#include <vtkm/VectorAnalysis.h>
namespace vtkm
{
namespace worklet
{
namespace internal
{
// Given a cell and a point on the cell, find the two edges that are
// associated with this point in canonical index
template <typename PointFromCellSetType>
VTKM_EXEC vtkm::ErrorCode FindRelatedEdges(const vtkm::Id& pointIndex,
const vtkm::Id& cellIndexG,
const PointFromCellSetType& pFromCellSet,
vtkm::Id2& edge0G,
vtkm::Id2& edge1G)
{
typename PointFromCellSetType::CellShapeTag cellShape = pFromCellSet.GetCellShape(cellIndexG);
typename PointFromCellSetType::IndicesType cellConnections = pFromCellSet.GetIndices(cellIndexG);
vtkm::IdComponent numPointsInCell = pFromCellSet.GetNumberOfIndices(cellIndexG);
vtkm::IdComponent numEdges;
VTKM_RETURN_ON_ERROR(vtkm::exec::CellEdgeNumberOfEdges(numPointsInCell, cellShape, numEdges));
vtkm::IdComponent edgeIndex = -1;
// Find the two edges with the pointIndex
while (true)
{
++edgeIndex;
if (edgeIndex >= numEdges)
{
// Bad cell. Could not find two incident edges.
return vtkm::ErrorCode::MalformedCellDetected;
}
vtkm::IdComponent2 localEdgeIndices;
VTKM_RETURN_ON_ERROR(vtkm::exec::CellEdgeLocalIndex(
numPointsInCell, 0, edgeIndex, cellShape, localEdgeIndices[0]));
VTKM_RETURN_ON_ERROR(vtkm::exec::CellEdgeLocalIndex(
numPointsInCell, 1, edgeIndex, cellShape, localEdgeIndices[1]));
vtkm::Id2 canonicalEdgeId(cellConnections[localEdgeIndices[0]],
cellConnections[localEdgeIndices[1]]);
if (canonicalEdgeId[0] == pointIndex || canonicalEdgeId[1] == pointIndex)
{ // Assign value to edge0 first
if ((edge0G[0] == -1) && (edge0G[1] == -1))
{
edge0G = canonicalEdgeId;
}
else
{
edge1G = canonicalEdgeId;
break;
}
}
}
return vtkm::ErrorCode::Success;
}
// TODO: We should replace this expensive lookup with a WholeCellSetIn<Edge, Cell> map.
// Given an edge on a cell, it would find the neighboring
// cell of this edge in local index. If it's a non manifold edge, -1 would be returned.
template <typename PointFromCellSetType, typename IncidentCellVecType>
VTKM_EXEC int FindNeighborCellInLocalIndex(const vtkm::Id2& eOI,
const PointFromCellSetType& pFromCellSet,
const IncidentCellVecType& incidentCells,
const vtkm::Id currentCellLocalIndex)
{
int neighboringCellIndex = -1;
vtkm::IdComponent numberOfIncidentCells = incidentCells.GetNumberOfComponents();
size_t neighboringCellsCount = 0;
for (vtkm::IdComponent incidentCellIndex = 0; incidentCellIndex < numberOfIncidentCells;
incidentCellIndex++)
{
if (currentCellLocalIndex == incidentCellIndex)
{
continue; // No need to check the current interested cell
}
vtkm::Id cellIndexG = incidentCells[incidentCellIndex]; // Global cell index
typename PointFromCellSetType::CellShapeTag cellShape = pFromCellSet.GetCellShape(cellIndexG);
typename PointFromCellSetType::IndicesType cellConnections =
pFromCellSet.GetIndices(cellIndexG);
vtkm::IdComponent numPointsInCell = pFromCellSet.GetNumberOfIndices(cellIndexG);
vtkm::IdComponent numEdges;
vtkm::exec::CellEdgeNumberOfEdges(numPointsInCell, cellShape, numEdges);
vtkm::IdComponent edgeIndex = -1;
// Check if this cell has edge of interest
while (true)
{
++edgeIndex;
if (edgeIndex >= numEdges)
{
break;
}
vtkm::IdComponent2 localEdgeIndices;
vtkm::exec::CellEdgeLocalIndex(numPointsInCell, 0, edgeIndex, cellShape, localEdgeIndices[0]);
vtkm::exec::CellEdgeLocalIndex(numPointsInCell, 1, edgeIndex, cellShape, localEdgeIndices[1]);
vtkm::Id2 canonicalEdgeId(cellConnections[localEdgeIndices[0]],
cellConnections[localEdgeIndices[1]]);
if ((canonicalEdgeId[0] == eOI[0] && canonicalEdgeId[1] == eOI[1]) ||
(canonicalEdgeId[0] == eOI[1] && canonicalEdgeId[1] == eOI[0]))
{
neighboringCellIndex = incidentCellIndex;
neighboringCellsCount++;
break;
}
}
}
return neighboringCellIndex;
}
// Generalized logic for finding what 'regions' own the connected cells.
template <typename IncidentCellVecType, typename PointFromCellSetType, typename FaceNormalVecType>
VTKM_EXEC bool FindConnectedCellOwnerships(vtkm::FloatDefault cosFeatureAngle,
const IncidentCellVecType& incidentCells,
vtkm::Id pointIndex,
const PointFromCellSetType& pFromCellSet,
const FaceNormalVecType& faceNormals,
vtkm::Id visitedCellsRegionIndex[64],
vtkm::Id& regionIndex)
{
const vtkm::IdComponent numberOfIncidentCells = incidentCells.GetNumberOfComponents();
VTKM_ASSERT(numberOfIncidentCells < 64);
if (numberOfIncidentCells <= 1)
{
return false; // Not enough cells to compare
}
// Initialize a global cell mask to avoid confusion. globalCellIndex->status
// 0 means not visited yet 1 means visited.
vtkm::Bitset<vtkm::UInt64> visitedCells;
// Reallocate memory for visitedCellsGroup if needed
// Loop through each cell
for (vtkm::IdComponent incidentCellIndex = 0; incidentCellIndex < numberOfIncidentCells;
incidentCellIndex++)
{
vtkm::Id cellIndexG = incidentCells[incidentCellIndex]; // cell index in global order
// If not visited
if (!visitedCells.test(incidentCellIndex))
{
// Mark the cell and track the region
visitedCells.set(incidentCellIndex);
visitedCellsRegionIndex[incidentCellIndex] = regionIndex;
// Find two edges containing the current point in canonial index
vtkm::Id2 edge0G(-1, -1), edge1G(-1, -1);
internal::FindRelatedEdges(pointIndex, cellIndexG, pFromCellSet, edge0G, edge1G);
// Grow the area along each edge
for (size_t i = 0; i < 2; i++)
{ // Reset these two values for each grow operation
vtkm::Id2 currentEdgeG = i == 0 ? edge0G : edge1G;
vtkm::IdComponent currentTestingCellIndex = incidentCellIndex;
while (currentTestingCellIndex >= 0)
{
// Find the neighbor cell of the current cell edge in local index
int neighboringCellIndexQuery = internal::FindNeighborCellInLocalIndex(
currentEdgeG, pFromCellSet, incidentCells, currentTestingCellIndex);
// The edge should be manifold and the neighboring cell should
// have not been visited
if (neighboringCellIndexQuery != -1 && !visitedCells.test(neighboringCellIndexQuery))
{
vtkm::IdComponent neighborCellIndex =
static_cast<vtkm::IdComponent>(neighboringCellIndexQuery);
// Try to grow the area if the feature angle between current neighbor
auto thisNormal = faceNormals[currentTestingCellIndex];
//neighborNormal
auto neighborNormal = faceNormals[neighborCellIndex];
// Try to grow the area
if (vtkm::dot(thisNormal, neighborNormal) > cosFeatureAngle)
{ // No need to split.
visitedCells.set(neighborCellIndex);
// Mark the region visited
visitedCellsRegionIndex[neighborCellIndex] = regionIndex;
// Move to examine next cell
currentTestingCellIndex = neighborCellIndex;
vtkm::Id2 neighborCellEdge0G(-1, -1), neighborCellEdge1G(-1, -1);
internal::FindRelatedEdges(pointIndex,
incidentCells[currentTestingCellIndex],
pFromCellSet,
neighborCellEdge0G,
neighborCellEdge1G);
// Update currentEdgeG
if ((currentEdgeG == neighborCellEdge0G) ||
currentEdgeG == vtkm::Id2(neighborCellEdge0G[1], neighborCellEdge0G[0]))
{
currentEdgeG = neighborCellEdge1G;
}
else
{
currentEdgeG = neighborCellEdge0G;
}
}
else
{
currentTestingCellIndex = -1;
}
}
else
{
currentTestingCellIndex =
-1; // Either seperated by previous visit, boundary or non-manifold
}
// cells is smaller than the thresold and the nighboring cell has not been visited
}
}
regionIndex++;
}
}
return true;
}
} // internal namespace
// Split sharp manifold edges where the feature angle between the
// adjacent surfaces are larger than the threshold value
class SplitSharpEdges
{
public:
// This worklet would calculate the needed space for splitting sharp edges.
// For each point, it would have two values as numberOfNewPoint(how many
// times this point needs to be duplicated) and numberOfCellsNeedsUpdate
// (how many neighboring cells need to update connectivity).
// For example, Given a unit cube and feature angle
// as 89 degree, each point would be duplicated twice and there are two cells
// need connectivity update. There is no guarantee on which cell would get which
// new point.
class ClassifyPoint : public vtkm::worklet::WorkletVisitPointsWithCells
{
public:
ClassifyPoint(vtkm::FloatDefault cosfeatureAngle)
: CosFeatureAngle(cosfeatureAngle)
{
}
using ControlSignature = void(CellSetIn intputCells,
WholeCellSetIn<Cell, Point>, // Query points from cell
FieldInCell faceNormals,
FieldOutPoint newPointNum,
FieldOutPoint cellNum);
using ExecutionSignature = void(CellIndices incidentCells,
InputIndex pointIndex,
_2 pFromCellSet,
_3 faceNormals,
_4 newPointNum,
_5 cellNum);
using InputDomain = _1;
template <typename IncidentCellVecType,
typename PointFromCellSetType,
typename FaceNormalVecType>
VTKM_EXEC void operator()(const IncidentCellVecType& incidentCells,
vtkm::Id pointIndex,
const PointFromCellSetType& pFromCellSet,
const FaceNormalVecType& faceNormals,
vtkm::Id& newPointNum,
vtkm::Id& cellNum) const
{
vtkm::Id regionIndex = 0;
vtkm::Id visitedCellsRegionIndex[64] = { 0 };
const bool foundConnections = internal::FindConnectedCellOwnerships(this->CosFeatureAngle,
incidentCells,
pointIndex,
pFromCellSet,
faceNormals,
visitedCellsRegionIndex,
regionIndex);
if (!foundConnections)
{
newPointNum = 0;
cellNum = 0;
}
else
{
// For each new region you need a new point
vtkm::Id numberOfCellsNeedUpdate = 0;
const vtkm::IdComponent size = incidentCells.GetNumberOfComponents();
for (vtkm::IdComponent i = 0; i < size; i++)
{
if (visitedCellsRegionIndex[i] > 0)
{
numberOfCellsNeedUpdate++;
}
}
newPointNum = regionIndex - 1;
cellNum = numberOfCellsNeedUpdate;
}
}
private:
vtkm::FloatDefault CosFeatureAngle; // Cos value of the feature angle
};
// This worklet split the sharp edges and populate the
// cellTopologyUpdateTuples as (cellGlobalId, oldPointId, newPointId).
class SplitSharpEdge : public vtkm::worklet::WorkletVisitPointsWithCells
{
public:
SplitSharpEdge(vtkm::FloatDefault cosfeatureAngle, vtkm::Id numberOfOldPoints)
: CosFeatureAngle(cosfeatureAngle)
, NumberOfOldPoints(numberOfOldPoints)
{
}
using ControlSignature = void(CellSetIn intputCells,
WholeCellSetIn<Cell, Point>, // Query points from cell
FieldInCell faceNormals,
FieldInPoint newPointStartingIndex,
FieldInPoint pointCellsStartingIndex,
WholeArrayOut cellTopologyUpdateTuples);
using ExecutionSignature = void(CellIndices incidentCells,
InputIndex pointIndex,
_2 pFromCellSet,
_3 faceNormals,
_4 newPointStartingIndex,
_5 pointCellsStartingIndex,
_6 cellTopologyUpdateTuples);
using InputDomain = _1;
template <typename IncidentCellVecType,
typename PointFromCellSetType,
typename FaceNormalVecType,
typename CellTopologyUpdateTuples>
VTKM_EXEC void operator()(const IncidentCellVecType& incidentCells,
vtkm::Id pointIndex,
const PointFromCellSetType& pFromCellSet,
const FaceNormalVecType& faceNormals,
const vtkm::Id& newPointStartingIndex,
const vtkm::Id& pointCellsStartingIndex,
CellTopologyUpdateTuples& cellTopologyUpdateTuples) const
{
vtkm::Id regionIndex = 0;
vtkm::Id visitedCellsRegionIndex[64] = { 0 };
const bool foundConnections = internal::FindConnectedCellOwnerships(this->CosFeatureAngle,
incidentCells,
pointIndex,
pFromCellSet,
faceNormals,
visitedCellsRegionIndex,
regionIndex);
if (foundConnections)
{
// For each new region you need a new point
// Initialize the offset in the global cellTopologyUpdateTuples;
vtkm::Id cellTopologyUpdateTuplesIndex = pointCellsStartingIndex;
const vtkm::IdComponent size = incidentCells.GetNumberOfComponents();
for (vtkm::Id i = 0; i < size; i++)
{
if (visitedCellsRegionIndex[i])
{ // New region generated. Need to update the topology
vtkm::Id replacementPointId =
NumberOfOldPoints + newPointStartingIndex + visitedCellsRegionIndex[i] - 1;
vtkm::Id globalCellId = incidentCells[static_cast<vtkm::IdComponent>(i)];
// (cellGlobalIndex, oldPointId, replacementPointId)
vtkm::Id3 tuple = vtkm::make_Vec(globalCellId, pointIndex, replacementPointId);
cellTopologyUpdateTuples.Set(cellTopologyUpdateTuplesIndex, tuple);
cellTopologyUpdateTuplesIndex++;
}
}
}
}
private:
vtkm::FloatDefault CosFeatureAngle; // Cos value of the feature angle
vtkm::Id NumberOfOldPoints;
};
template <typename CellSetType,
typename FaceNormalsType,
typename CoordsComType,
typename CoordsInStorageType,
typename CoordsOutStorageType,
typename NewCellSetType>
void Run(
const CellSetType& oldCellset,
const vtkm::FloatDefault featureAngle,
const FaceNormalsType& faceNormals,
const vtkm::cont::ArrayHandle<vtkm::Vec<CoordsComType, 3>, CoordsInStorageType>& oldCoords,
vtkm::cont::ArrayHandle<vtkm::Vec<CoordsComType, 3>, CoordsOutStorageType>& newCoords,
NewCellSetType& newCellset)
{
vtkm::cont::Invoker invoke;
const vtkm::FloatDefault featureAngleR =
featureAngle / static_cast<vtkm::FloatDefault>(180.0) * vtkm::Pi<vtkm::FloatDefault>();
//Launch the first kernel that computes which points need to be split
vtkm::cont::ArrayHandle<vtkm::Id> newPointNums, cellNeedUpdateNums;
ClassifyPoint classifyPoint(vtkm::Cos(featureAngleR));
invoke(classifyPoint, oldCellset, oldCellset, faceNormals, newPointNums, cellNeedUpdateNums);
VTKM_ASSERT(newPointNums.GetNumberOfValues() == oldCoords.GetNumberOfValues());
//Compute relevant information from cellNeedUpdateNums so we can release
//that memory asap
vtkm::cont::ArrayHandle<vtkm::Id> pointCellsStartingIndexs;
vtkm::cont::Algorithm::ScanExclusive(cellNeedUpdateNums, pointCellsStartingIndexs);
const vtkm::Id cellsNeedUpdateNum =
vtkm::cont::Algorithm::Reduce(cellNeedUpdateNums, vtkm::Id(0));
cellNeedUpdateNums.ReleaseResources();
//Compute the mapping of new points to old points. This is required for
//processing additional point fields
const vtkm::Id totalNewPointsNum = vtkm::cont::Algorithm::Reduce(newPointNums, vtkm::Id(0));
this->NewPointsIdArray.Allocate(oldCoords.GetNumberOfValues() + totalNewPointsNum);
vtkm::cont::Algorithm::CopySubRange(
vtkm::cont::make_ArrayHandleCounting(vtkm::Id(0), vtkm::Id(1), oldCoords.GetNumberOfValues()),
0,
oldCoords.GetNumberOfValues(),
this->NewPointsIdArray,
0);
auto newPointsIdArrayPortal = this->NewPointsIdArray.WritePortal();
// Fill the new point coordinate system with all the existing values
newCoords.Allocate(oldCoords.GetNumberOfValues() + totalNewPointsNum);
vtkm::cont::Algorithm::CopySubRange(oldCoords, 0, oldCoords.GetNumberOfValues(), newCoords);
if (totalNewPointsNum > 0)
{ //only if we have new points do we need add any of the new
//coordinate locations
vtkm::Id newCoordsIndex = oldCoords.GetNumberOfValues();
auto oldCoordsPortal = oldCoords.ReadPortal();
auto newCoordsPortal = newCoords.WritePortal();
auto newPointNumsPortal = newPointNums.WritePortal();
for (vtkm::Id i = 0; i < oldCoords.GetNumberOfValues(); i++)
{ // Find out for each new point, how many times it should be added
for (vtkm::Id j = 0; j < newPointNumsPortal.Get(i); j++)
{
newPointsIdArrayPortal.Set(newCoordsIndex, i);
newCoordsPortal.Set(newCoordsIndex++, oldCoordsPortal.Get(i));
}
}
}
// Allocate the size for the updateCellTopologyArray
vtkm::cont::ArrayHandle<vtkm::Id3> cellTopologyUpdateTuples;
cellTopologyUpdateTuples.Allocate(cellsNeedUpdateNum);
vtkm::cont::ArrayHandle<vtkm::Id> newpointStartingIndexs;
vtkm::cont::Algorithm::ScanExclusive(newPointNums, newpointStartingIndexs);
newPointNums.ReleaseResources();
SplitSharpEdge splitSharpEdge(vtkm::Cos(featureAngleR), oldCoords.GetNumberOfValues());
invoke(splitSharpEdge,
oldCellset,
oldCellset,
faceNormals,
newpointStartingIndexs,
pointCellsStartingIndexs,
cellTopologyUpdateTuples);
auto ctutPortal = cellTopologyUpdateTuples.ReadPortal();
vtkm::cont::printSummary_ArrayHandle(cellTopologyUpdateTuples, std::cout);
// Create the new cellset
CellDeepCopy::Run(oldCellset, newCellset);
// FIXME: Since the non const get array function is not in CellSetExplict.h,
// here I just get a non-const copy of the array handle.
auto connectivityArrayHandle = newCellset.GetConnectivityArray(vtkm::TopologyElementTagCell(),
vtkm::TopologyElementTagPoint());
auto connectivityArrayHandleP = connectivityArrayHandle.WritePortal();
auto offsetArrayHandle =
newCellset.GetOffsetsArray(vtkm::TopologyElementTagCell(), vtkm::TopologyElementTagPoint());
auto offsetArrayHandleP = offsetArrayHandle.WritePortal();
for (vtkm::Id i = 0; i < cellTopologyUpdateTuples.GetNumberOfValues(); i++)
{
vtkm::Id cellId(ctutPortal.Get(i)[0]), oldPointId(ctutPortal.Get(i)[1]),
newPointId(ctutPortal.Get(i)[2]);
vtkm::Id bound = (cellId + 1 == offsetArrayHandle.GetNumberOfValues())
? connectivityArrayHandle.GetNumberOfValues()
: offsetArrayHandleP.Get(cellId + 1);
vtkm::Id k = 0;
for (vtkm::Id j = offsetArrayHandleP.Get(cellId); j < bound; j++, k++)
{
if (connectivityArrayHandleP.Get(j) == oldPointId)
{
connectivityArrayHandleP.Set(j, newPointId);
}
}
}
}
template <typename ValueType, typename StorageTag>
vtkm::cont::ArrayHandle<ValueType> ProcessPointField(
const vtkm::cont::ArrayHandle<ValueType, StorageTag> in) const
{
// Use a temporary permutation array to simplify the mapping:
auto tmp = vtkm::cont::make_ArrayHandlePermutation(this->NewPointsIdArray, in);
// Copy into an array with default storage:
vtkm::cont::ArrayHandle<ValueType> result;
vtkm::cont::ArrayCopy(tmp, result);
return result;
}
private:
vtkm::cont::ArrayHandle<vtkm::Id> NewPointsIdArray;
};
}
} // vtkm::worklet
#endif // vtk_m_worklet_SplitSharpEdges_h