2019-04-15 23:24:21 +00:00
|
|
|
//============================================================================
|
2017-07-26 20:59:48 +00:00
|
|
|
// 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.
|
2019-04-15 23:24:21 +00:00
|
|
|
//============================================================================
|
2017-07-26 20:59:48 +00:00
|
|
|
#ifndef vtk_m_cont_ArrayHandleExtractComponent_h
|
|
|
|
#define vtk_m_cont_ArrayHandleExtractComponent_h
|
|
|
|
|
|
|
|
#include <vtkm/VecTraits.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
|
|
|
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace cont
|
|
|
|
{
|
|
|
|
namespace internal
|
|
|
|
{
|
|
|
|
|
2018-05-10 16:37:05 +00:00
|
|
|
template <typename PortalType>
|
2017-07-26 20:59:48 +00:00
|
|
|
class VTKM_ALWAYS_EXPORT ArrayPortalExtractComponent
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
using VectorType = typename PortalType::ValueType;
|
|
|
|
using Traits = vtkm::VecTraits<VectorType>;
|
2017-10-10 20:11:46 +00:00
|
|
|
using ValueType = typename Traits::ComponentType;
|
|
|
|
|
2017-07-26 20:59:48 +00:00
|
|
|
VTKM_EXEC_CONT
|
|
|
|
ArrayPortalExtractComponent()
|
|
|
|
: Portal()
|
2018-05-10 16:37:05 +00:00
|
|
|
, Component(0)
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_EXEC_CONT
|
2018-05-10 16:37:05 +00:00
|
|
|
ArrayPortalExtractComponent(const PortalType& portal, vtkm::IdComponent component)
|
2017-07-26 20:59:48 +00:00
|
|
|
: Portal(portal)
|
2018-05-10 16:37:05 +00:00
|
|
|
, Component(component)
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
// Copy constructor
|
2018-05-10 16:37:05 +00:00
|
|
|
VTKM_EXEC_CONT ArrayPortalExtractComponent(const ArrayPortalExtractComponent<PortalType>& src)
|
|
|
|
: Portal(src.Portal)
|
|
|
|
, Component(src.Component)
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_EXEC_CONT
|
|
|
|
vtkm::Id GetNumberOfValues() const { return this->Portal.GetNumberOfValues(); }
|
|
|
|
|
|
|
|
VTKM_EXEC_CONT
|
2017-10-10 20:11:46 +00:00
|
|
|
ValueType Get(vtkm::Id index) const
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
2018-05-10 16:37:05 +00:00
|
|
|
return Traits::GetComponent(this->Portal.Get(index), this->Component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_EXEC_CONT
|
2017-10-10 20:11:46 +00:00
|
|
|
void Set(vtkm::Id index, const ValueType& value) const
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
VectorType vec = this->Portal.Get(index);
|
2018-05-10 16:37:05 +00:00
|
|
|
Traits::SetComponent(vec, this->Component, value);
|
2017-07-26 20:59:48 +00:00
|
|
|
this->Portal.Set(index, vec);
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_EXEC_CONT
|
|
|
|
const PortalType& GetPortal() const { return this->Portal; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
PortalType Portal;
|
2018-05-10 16:37:05 +00:00
|
|
|
vtkm::IdComponent Component;
|
2017-07-26 20:59:48 +00:00
|
|
|
}; // class ArrayPortalExtractComponent
|
|
|
|
|
|
|
|
} // namespace internal
|
|
|
|
|
2018-05-10 16:37:05 +00:00
|
|
|
template <typename ArrayHandleType>
|
2017-07-26 20:59:48 +00:00
|
|
|
class StorageTagExtractComponent
|
|
|
|
{
|
|
|
|
};
|
|
|
|
|
|
|
|
namespace internal
|
|
|
|
{
|
|
|
|
|
2018-05-10 16:37:05 +00:00
|
|
|
template <typename ArrayHandleType>
|
2017-07-26 20:59:48 +00:00
|
|
|
class Storage<typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType,
|
2018-05-10 16:37:05 +00:00
|
|
|
StorageTagExtractComponent<ArrayHandleType>>
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
public:
|
2018-05-10 16:37:05 +00:00
|
|
|
using PortalType = ArrayPortalExtractComponent<typename ArrayHandleType::PortalControl>;
|
|
|
|
using PortalConstType = ArrayPortalExtractComponent<typename ArrayHandleType::PortalConstControl>;
|
2017-10-10 20:11:46 +00:00
|
|
|
using ValueType = typename PortalType::ValueType;
|
2017-07-26 20:59:48 +00:00
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
Storage()
|
2018-05-10 16:37:05 +00:00
|
|
|
: Array()
|
|
|
|
, Component(0)
|
|
|
|
, Valid(false)
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
2018-05-10 16:37:05 +00:00
|
|
|
Storage(const ArrayHandleType& array, vtkm::IdComponent component)
|
2017-07-26 20:59:48 +00:00
|
|
|
: Array(array)
|
2018-05-10 16:37:05 +00:00
|
|
|
, Component(component)
|
2017-07-26 20:59:48 +00:00
|
|
|
, Valid(true)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
PortalConstType GetPortalConst() const
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
2018-05-10 16:37:05 +00:00
|
|
|
return PortalConstType(this->Array.GetPortalConstControl(), this->Component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
PortalType GetPortal()
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
2018-05-10 16:37:05 +00:00
|
|
|
return PortalType(this->Array.GetPortalControl(), this->Component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
vtkm::Id GetNumberOfValues() const
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
|
|
|
return this->Array.GetNumberOfValues();
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
void Allocate(vtkm::Id numberOfValues)
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
|
|
|
this->Array.Allocate(numberOfValues);
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
void Shrink(vtkm::Id numberOfValues)
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
|
|
|
this->Array.Shrink(numberOfValues);
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
void ReleaseResources()
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
|
|
|
this->Array.ReleaseResources();
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
const ArrayHandleType& GetArray() const
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
|
|
|
return this->Array;
|
|
|
|
}
|
|
|
|
|
2018-05-10 16:37:05 +00:00
|
|
|
VTKM_CONT
|
|
|
|
vtkm::IdComponent GetComponent() const
|
|
|
|
{
|
|
|
|
VTKM_ASSERT(this->Valid);
|
|
|
|
return this->Component;
|
|
|
|
}
|
|
|
|
|
2017-07-26 20:59:48 +00:00
|
|
|
private:
|
|
|
|
ArrayHandleType Array;
|
2018-05-10 16:37:05 +00:00
|
|
|
vtkm::IdComponent Component;
|
2017-07-26 20:59:48 +00:00
|
|
|
bool Valid;
|
|
|
|
}; // class Storage
|
|
|
|
|
2018-05-10 16:37:05 +00:00
|
|
|
template <typename ArrayHandleType, typename Device>
|
2017-07-26 20:59:48 +00:00
|
|
|
class ArrayTransfer<typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType,
|
2018-05-10 16:37:05 +00:00
|
|
|
StorageTagExtractComponent<ArrayHandleType>,
|
2017-07-26 20:59:48 +00:00
|
|
|
Device>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
using ValueType = typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType;
|
|
|
|
|
|
|
|
private:
|
2018-05-10 16:37:05 +00:00
|
|
|
using StorageTag = StorageTagExtractComponent<ArrayHandleType>;
|
2017-07-26 20:59:48 +00:00
|
|
|
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
|
|
|
|
using ArrayValueType = typename ArrayHandleType::ValueType;
|
|
|
|
using ArrayStorageTag = typename ArrayHandleType::StorageTag;
|
|
|
|
using ArrayStorageType =
|
|
|
|
vtkm::cont::internal::Storage<typename ArrayHandleType::ValueType, ArrayStorageTag>;
|
|
|
|
|
|
|
|
public:
|
|
|
|
using PortalControl = typename StorageType::PortalType;
|
|
|
|
using PortalConstControl = typename StorageType::PortalConstType;
|
|
|
|
|
|
|
|
using ExecutionTypes = typename ArrayHandleType::template ExecutionTypes<Device>;
|
2018-05-10 16:37:05 +00:00
|
|
|
using PortalExecution = ArrayPortalExtractComponent<typename ExecutionTypes::Portal>;
|
|
|
|
using PortalConstExecution = ArrayPortalExtractComponent<typename ExecutionTypes::PortalConst>;
|
2017-07-26 20:59:48 +00:00
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
ArrayTransfer(StorageType* storage)
|
|
|
|
: Array(storage->GetArray())
|
2018-05-10 16:37:05 +00:00
|
|
|
, Component(storage->GetComponent())
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
vtkm::Id GetNumberOfValues() const { return this->Array.GetNumberOfValues(); }
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
PortalConstExecution PrepareForInput(bool vtkmNotUsed(updateData))
|
|
|
|
{
|
2018-05-10 16:37:05 +00:00
|
|
|
return PortalConstExecution(this->Array.PrepareForInput(Device()), this->Component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
PortalExecution PrepareForInPlace(bool vtkmNotUsed(updateData))
|
|
|
|
{
|
2018-05-10 16:37:05 +00:00
|
|
|
return PortalExecution(this->Array.PrepareForInPlace(Device()), this->Component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
PortalExecution PrepareForOutput(vtkm::Id numberOfValues)
|
|
|
|
{
|
2018-05-10 16:37:05 +00:00
|
|
|
return PortalExecution(this->Array.PrepareForOutput(numberOfValues, Device()), this->Component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
void RetrieveOutputData(StorageType* vtkmNotUsed(storage)) const
|
|
|
|
{
|
|
|
|
// Implementation of this method should be unnecessary. The internal
|
|
|
|
// array handle should automatically retrieve the output data as
|
|
|
|
// necessary.
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
void Shrink(vtkm::Id numberOfValues) { this->Array.Shrink(numberOfValues); }
|
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
void ReleaseResources() { this->Array.ReleaseResourcesExecution(); }
|
|
|
|
|
|
|
|
private:
|
|
|
|
ArrayHandleType Array;
|
2018-05-10 16:37:05 +00:00
|
|
|
vtkm::IdComponent Component;
|
2017-07-26 20:59:48 +00:00
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} // namespace vtkm::cont::internal
|
|
|
|
|
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace cont
|
|
|
|
{
|
|
|
|
|
|
|
|
/// \brief A fancy ArrayHandle that turns a vector array into a scalar array by
|
|
|
|
/// slicing out a single component of each vector.
|
|
|
|
///
|
|
|
|
/// ArrayHandleExtractComponent is a specialization of ArrayHandle. It takes an
|
|
|
|
/// input ArrayHandle with a vtkm::Vec ValueType and a component index
|
|
|
|
/// and uses this information to expose a scalar array consisting of the
|
|
|
|
/// specified component across all vectors in the input ArrayHandle. So for a
|
|
|
|
/// given index i, ArrayHandleExtractComponent looks up the i-th vtkm::Vec in
|
|
|
|
/// the index array and reads or writes to the specified component, leave all
|
|
|
|
/// other components unmodified. This is done on the fly rather than creating a
|
|
|
|
/// copy of the array.
|
2018-05-10 16:37:05 +00:00
|
|
|
template <typename ArrayHandleType>
|
2017-07-26 20:59:48 +00:00
|
|
|
class ArrayHandleExtractComponent
|
|
|
|
: public vtkm::cont::ArrayHandle<
|
|
|
|
typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType,
|
2018-05-10 16:37:05 +00:00
|
|
|
StorageTagExtractComponent<ArrayHandleType>>
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
VTKM_ARRAY_HANDLE_SUBCLASS(
|
|
|
|
ArrayHandleExtractComponent,
|
2018-05-10 16:37:05 +00:00
|
|
|
(ArrayHandleExtractComponent<ArrayHandleType>),
|
2017-07-26 20:59:48 +00:00
|
|
|
(vtkm::cont::ArrayHandle<
|
|
|
|
typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType,
|
2018-05-10 16:37:05 +00:00
|
|
|
StorageTagExtractComponent<ArrayHandleType>>));
|
2017-07-26 20:59:48 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
|
|
|
|
|
|
|
|
public:
|
|
|
|
VTKM_CONT
|
2018-05-10 16:37:05 +00:00
|
|
|
ArrayHandleExtractComponent(const ArrayHandleType& array, vtkm::IdComponent component)
|
|
|
|
: Superclass(StorageType(array, component))
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/// make_ArrayHandleExtractComponent is convenience function to generate an
|
|
|
|
/// ArrayHandleExtractComponent.
|
2018-05-10 16:37:05 +00:00
|
|
|
template <typename ArrayHandleType>
|
|
|
|
VTKM_CONT ArrayHandleExtractComponent<ArrayHandleType> make_ArrayHandleExtractComponent(
|
|
|
|
const ArrayHandleType& array,
|
|
|
|
vtkm::IdComponent component)
|
2017-07-26 20:59:48 +00:00
|
|
|
{
|
2018-05-10 16:37:05 +00:00
|
|
|
return ArrayHandleExtractComponent<ArrayHandleType>(array, component);
|
2017-07-26 20:59:48 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
} // namespace vtkm::cont
|
|
|
|
|
2018-06-08 15:56:40 +00:00
|
|
|
//=============================================================================
|
|
|
|
// Specializations of serialization related classes
|
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace cont
|
|
|
|
{
|
|
|
|
|
|
|
|
template <typename AH>
|
2019-02-28 18:15:27 +00:00
|
|
|
struct SerializableTypeString<vtkm::cont::ArrayHandleExtractComponent<AH>>
|
2018-06-08 15:56:40 +00:00
|
|
|
{
|
|
|
|
static VTKM_CONT const std::string& Get()
|
|
|
|
{
|
2019-02-28 18:15:27 +00:00
|
|
|
static std::string name = "AH_ExtractComponent<" + SerializableTypeString<AH>::Get() + ">";
|
2018-06-08 15:56:40 +00:00
|
|
|
return name;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <typename AH>
|
2019-02-28 18:15:27 +00:00
|
|
|
struct SerializableTypeString<
|
2018-06-08 15:56:40 +00:00
|
|
|
vtkm::cont::ArrayHandle<typename vtkm::VecTraits<typename AH::ValueType>::ComponentType,
|
|
|
|
vtkm::cont::StorageTagExtractComponent<AH>>>
|
2019-02-28 18:15:27 +00:00
|
|
|
: SerializableTypeString<vtkm::cont::ArrayHandleExtractComponent<AH>>
|
2018-06-08 15:56:40 +00:00
|
|
|
{
|
|
|
|
};
|
|
|
|
}
|
|
|
|
} // vtkm::cont
|
|
|
|
|
2019-02-05 16:02:29 +00:00
|
|
|
namespace mangled_diy_namespace
|
2018-06-08 15:56:40 +00:00
|
|
|
{
|
|
|
|
|
|
|
|
template <typename AH>
|
|
|
|
struct Serialization<vtkm::cont::ArrayHandleExtractComponent<AH>>
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
using Type = vtkm::cont::ArrayHandleExtractComponent<AH>;
|
|
|
|
using BaseType = vtkm::cont::ArrayHandle<typename Type::ValueType, typename Type::StorageTag>;
|
|
|
|
|
|
|
|
public:
|
|
|
|
static VTKM_CONT void save(BinaryBuffer& bb, const BaseType& obj)
|
|
|
|
{
|
|
|
|
auto storage = obj.GetStorage();
|
2019-02-05 16:02:29 +00:00
|
|
|
vtkmdiy::save(bb, storage.GetComponent());
|
|
|
|
vtkmdiy::save(bb, storage.GetArray());
|
2018-06-08 15:56:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static VTKM_CONT void load(BinaryBuffer& bb, BaseType& obj)
|
|
|
|
{
|
|
|
|
vtkm::IdComponent component = 0;
|
|
|
|
AH array;
|
2019-02-05 16:02:29 +00:00
|
|
|
vtkmdiy::load(bb, component);
|
|
|
|
vtkmdiy::load(bb, array);
|
2018-06-08 15:56:40 +00:00
|
|
|
|
|
|
|
obj = vtkm::cont::make_ArrayHandleExtractComponent(array, component);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <typename AH>
|
|
|
|
struct Serialization<
|
|
|
|
vtkm::cont::ArrayHandle<typename vtkm::VecTraits<typename AH::ValueType>::ComponentType,
|
|
|
|
vtkm::cont::StorageTagExtractComponent<AH>>>
|
|
|
|
: Serialization<vtkm::cont::ArrayHandleExtractComponent<AH>>
|
|
|
|
{
|
|
|
|
};
|
|
|
|
} // diy
|
|
|
|
|
2017-07-26 20:59:48 +00:00
|
|
|
#endif // vtk_m_cont_ArrayHandleExtractComponent_h
|