d8d6fd1741
Class that need to be passed across dynamic library boundaries such as DynamicArrayHandle need to be properly export. One of 'tricks' of this is that templated classes such as PolymorphicArrayHandleContainer need the Type and Storage types to have public visibility. This makes sure that all vtkm storage tags have public visibility so in the future we can transfer dynamic array handles across libraries.
188 lines
5.2 KiB
C++
188 lines
5.2 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 2014 Sandia Corporation.
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
// 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.
|
|
//============================================================================
|
|
#ifndef vtk_m_cont_StorageImplicit
|
|
#define vtk_m_cont_StorageImplicit
|
|
|
|
#include <vtkm/Types.h>
|
|
|
|
#include <vtkm/cont/ArrayPortalToIterators.h>
|
|
#include <vtkm/cont/ErrorControlBadValue.h>
|
|
#include <vtkm/cont/Storage.h>
|
|
|
|
#include <vtkm/cont/internal/ArrayTransfer.h>
|
|
|
|
namespace vtkm {
|
|
namespace cont {
|
|
|
|
/// \brief An implementation for read-only implicit arrays.
|
|
///
|
|
/// It is sometimes the case that you want VTK-m to operate on an array of
|
|
/// implicit values. That is, rather than store the data in an actual array, it
|
|
/// is gerenated on the fly by a function. This is handled in VTK-m by creating
|
|
/// an ArrayHandle in VTK-m with a StorageTagImplicit type of \c Storage. This
|
|
/// tag itself is templated to specify an ArrayPortal that generates the
|
|
/// desired values. An ArrayHandle created with this tag will raise an error on
|
|
/// any operation that tries to modify it.
|
|
///
|
|
template<class ArrayPortalType>
|
|
struct VTKM_ALWAYS_EXPORT StorageTagImplicit
|
|
{
|
|
typedef ArrayPortalType PortalType;
|
|
};
|
|
|
|
namespace internal {
|
|
|
|
template<class ArrayPortalType>
|
|
class Storage<
|
|
typename ArrayPortalType::ValueType,
|
|
StorageTagImplicit<ArrayPortalType> >
|
|
{
|
|
public:
|
|
typedef typename ArrayPortalType::ValueType ValueType;
|
|
typedef ArrayPortalType PortalConstType;
|
|
|
|
// This is meant to be invalid. Because implicit arrays are read only, you
|
|
// should only be able to use the const version.
|
|
struct PortalType
|
|
{
|
|
typedef void *ValueType;
|
|
typedef void *IteratorType;
|
|
};
|
|
|
|
VTKM_CONT
|
|
Storage(const PortalConstType &portal = PortalConstType())
|
|
: Portal(portal) { }
|
|
|
|
// All these methods do nothing but raise errors.
|
|
VTKM_CONT
|
|
PortalType GetPortal()
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue("Implicit arrays are read-only.");
|
|
}
|
|
VTKM_CONT
|
|
PortalConstType GetPortalConst() const
|
|
{
|
|
return this->Portal;
|
|
}
|
|
VTKM_CONT
|
|
vtkm::Id GetNumberOfValues() const
|
|
{
|
|
return this->Portal.GetNumberOfValues();
|
|
}
|
|
VTKM_CONT
|
|
void Allocate(vtkm::Id vtkmNotUsed(numberOfValues))
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue("Implicit arrays are read-only.");
|
|
}
|
|
VTKM_CONT
|
|
void Shrink(vtkm::Id vtkmNotUsed(numberOfValues))
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue("Implicit arrays are read-only.");
|
|
}
|
|
VTKM_CONT
|
|
void ReleaseResources()
|
|
{
|
|
}
|
|
|
|
private:
|
|
PortalConstType Portal;
|
|
};
|
|
|
|
template<typename T, class ArrayPortalType, class DeviceAdapterTag>
|
|
class ArrayTransfer<T, StorageTagImplicit<ArrayPortalType>, DeviceAdapterTag>
|
|
{
|
|
private:
|
|
typedef StorageTagImplicit<ArrayPortalType> StorageTag;
|
|
typedef vtkm::cont::internal::Storage<T,StorageTag> StorageType;
|
|
|
|
public:
|
|
typedef T ValueType;
|
|
|
|
typedef typename StorageType::PortalType PortalControl;
|
|
typedef typename StorageType::PortalConstType PortalConstControl;
|
|
typedef PortalControl PortalExecution;
|
|
typedef PortalConstControl PortalConstExecution;
|
|
|
|
VTKM_CONT
|
|
ArrayTransfer(StorageType *storage) : Storage(storage) { }
|
|
|
|
VTKM_CONT
|
|
vtkm::Id GetNumberOfValues() const
|
|
{
|
|
return this->Storage->GetNumberOfValues();
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalConstExecution PrepareForInput(bool vtkmNotUsed(updateData))
|
|
{
|
|
return this->Storage->GetPortalConst();
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalExecution PrepareForInPlace(bool vtkmNotUsed(updateData))
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue(
|
|
"Implicit arrays cannot be used for output or in place.");
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalExecution PrepareForOutput(vtkm::Id vtkmNotUsed(numberOfValues))
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue(
|
|
"Implicit arrays cannot be used for output.");
|
|
}
|
|
VTKM_CONT
|
|
void RetrieveOutputData(StorageType *vtkmNotUsed(controlArray)) const
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue(
|
|
"Implicit arrays cannot be used for output.");
|
|
}
|
|
|
|
template <class IteratorTypeControl>
|
|
VTKM_CONT void CopyInto(IteratorTypeControl dest) const
|
|
{
|
|
typedef typename StorageType::PortalConstType PortalType;
|
|
PortalType portal = this->Storage->GetPortalConst();
|
|
|
|
std::copy(vtkm::cont::ArrayPortalToIteratorBegin(portal),
|
|
vtkm::cont::ArrayPortalToIteratorEnd(portal),
|
|
dest);
|
|
}
|
|
|
|
VTKM_CONT
|
|
void Shrink(vtkm::Id vtkmNotUsed(numberOfValues))
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue("Implicit arrays cannot be resized.");
|
|
}
|
|
|
|
VTKM_CONT
|
|
void ReleaseResources() { }
|
|
|
|
private:
|
|
StorageType *Storage;
|
|
};
|
|
|
|
} // namespace internal
|
|
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_StorageImplicit
|