VTK-m  1.5
Public Member Functions | Private Types | List of all members
vtkm::cont::ArrayHandleUniformPointCoordinates Class Reference

ArrayHandleUniformPointCoordinates is a specialization of ArrayHandle. More...

#include <ArrayHandleUniformPointCoordinates.h>

Inheritance diagram for vtkm::cont::ArrayHandleUniformPointCoordinates:
vtkm::cont::ArrayHandle< vtkm::Vec3f, vtkm::cont::StorageTagUniformPoints >

Public Member Functions

 VTKM_ARRAY_HANDLE_SUBCLASS_NT (ArrayHandleUniformPointCoordinates,(vtkm::cont::ArrayHandle< vtkm::Vec3f, vtkm::cont::StorageTagUniformPoints >))
 
VTKM_CONT ArrayHandleUniformPointCoordinates (vtkm::Id3 dimensions, ValueType origin=ValueType(0.0f, 0.0f, 0.0f), ValueType spacing=ValueType(1.0f, 1.0f, 1.0f))
 
 ~ArrayHandleUniformPointCoordinates ()
 Implemented so that it is defined exclusively in the control environment. More...
 
- Public Member Functions inherited from vtkm::cont::ArrayHandle< vtkm::Vec3f, vtkm::cont::StorageTagUniformPoints >
VTKM_CONT ArrayHandle ()
 Constructs an empty ArrayHandle. More...
 
 ArrayHandle (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
 Copy constructor. More...
 
 ArrayHandle (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
 Move constructor. More...
 
 ArrayHandle (const StorageType &storage)
 Special constructor for subclass specializations that need to set the initial state of the control array. More...
 
 ArrayHandle (StorageType &&storage) noexcept
 Special constructor for subclass specializations that need to set the initial state of the control array. More...
 
 ~ArrayHandle ()
 Destructs an empty ArrayHandle. More...
 
VTKM_CONT vtkm::cont::ArrayHandle< ValueType, StorageTag > & operator= (const vtkm::cont::ArrayHandle< ValueType, StorageTag > &src)
 Copies an ArrayHandle. More...
 
VTKM_CONT vtkm::cont::ArrayHandle< ValueType, StorageTag > & operator= (vtkm::cont::ArrayHandle< ValueType, StorageTag > &&src) noexcept
 Move and Assignment of an ArrayHandle. More...
 
VTKM_CONT bool operator== (const ArrayHandle< ValueType, StorageTag > &rhs) const
 Like a pointer, two ArrayHandles are considered equal if they point to the same location in memory. More...
 
VTKM_CONT bool operator== (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT bool operator!= (const ArrayHandle< ValueType, StorageTag > &rhs) const
 
VTKM_CONT bool operator!= (const ArrayHandle< VT, ST > &) const
 
VTKM_CONT StorageTypeGetStorage ()
 Get the storage. More...
 
const VTKM_CONT StorageTypeGetStorage () const
 Get the storage. More...
 
VTKM_CONT VTKM_DEPRECATED (1.6, "Use ArrayHandle::WritePortal() instead. " "Note that the returned portal will lock the array while it is in scope.") VTKM_CONT VTKM_DEPRECATED(1.6
 Get the array portal of the control array. More...
 
VTKM_CONT VTKM_DEPRECATED (1.6, "PrepareForInput now requires a vtkm::cont::Token object.") typename ExecutionTypes< DeviceAdapterTag >
 
VTKM_CONT VTKM_DEPRECATED (1.6, "PrepareForInPlace now requires a vtkm::cont::Token object.") typename ExecutionTypes< DeviceAdapterTag >
 
VTKM_CONT Use ArrayHandle::ReadPortal () instead. " "Note that the returned portal will lock the array while it is in scope.") VTKM_CONT ReadPortalType ReadPortal() const
 @{ More...
 
VTKM_CONT WritePortalType WritePortal () const
 @} More...
 
VTKM_CONT vtkm::Id GetNumberOfValues () const
 @} More...
 
VTKM_CONT void Allocate (vtkm::Id numberOfValues)
 Allocates an array large enough to hold the given number of values. More...
 
void Shrink (vtkm::Id numberOfValues)
 Reduces the size of the array without changing its values. More...
 
VTKM_CONT void ReleaseResourcesExecution ()
 Releases any resources being used in the execution environment (that are not being shared by the control environment). More...
 
VTKM_CONT void ReleaseResources ()
 Releases all resources in both the control and execution environments. More...
 
VTKM_CONT ExecutionTypes< DeviceAdapterTag >::PortalConst PrepareForInput (DeviceAdapterTag, vtkm::cont::Token &token) const
 Prepares this array to be used as an input to an operation in the execution environment. More...
 
VTKM_CONT ExecutionTypes< DeviceAdapterTag >::Portal PrepareForOutput (vtkm::Id numberOfValues, DeviceAdapterTag, vtkm::cont::Token &token)
 Prepares (allocates) this array to be used as an output from an operation in the execution environment. More...
 
VTKM_CONT ExecutionTypes< DeviceAdapterTag >::Portal PrepareForInPlace (DeviceAdapterTag, vtkm::cont::Token &token)
 Prepares this array to be used in an in-place operation (both as input and output) in the execution environment. More...
 
VTKM_CONT DeviceAdapterId GetDeviceAdapterId () const
 Returns the DeviceAdapterId for the current device. More...
 
VTKM_CONT void SyncControlArray () const
 Synchronizes the control array with the execution array. More...
 
VTKM_CONT void Enqueue (const vtkm::cont::Token &token) const
 Enqueue a token for access to this ArrayHandle. More...
 

Private Types

using StorageType = vtkm::cont::internal::Storage< ValueType, StorageTag >
 

Additional Inherited Members

- Public Types inherited from vtkm::cont::ArrayHandle< vtkm::Vec3f, vtkm::cont::StorageTagUniformPoints >
using StorageType = vtkm::cont::internal::Storage< vtkm::Vec3f, vtkm::cont::StorageTagUniformPoints >
 
using ValueType = vtkm::Vec3f
 
using StorageTag = vtkm::cont::StorageTagUniformPoints
 
using WritePortalType = vtkm::cont::internal::ArrayPortalCheck< typename StorageType::PortalType >
 
using ReadPortalType = vtkm::cont::internal::ArrayPortalCheck< typename StorageType::PortalConstType >
 
using instead = typename StorageType::PortalType
 
using instead = typename StorageType::PortalConstType
 

Detailed Description

ArrayHandleUniformPointCoordinates is a specialization of ArrayHandle.

It contains the information necessary to compute the point coordinates in a uniform orthogonal grid (extent, origin, and spacing) and implicitly computes these coordinates in its array portal.

Member Typedef Documentation

◆ StorageType

using vtkm::cont::ArrayHandleUniformPointCoordinates::StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>
private

Constructor & Destructor Documentation

◆ ArrayHandleUniformPointCoordinates()

VTKM_CONT vtkm::cont::ArrayHandleUniformPointCoordinates::ArrayHandleUniformPointCoordinates ( vtkm::Id3  dimensions,
ValueType  origin = ValueType(0.0f, 0.0f, 0.0f),
ValueType  spacing = ValueType(1.0f, 1.0f, 1.0f) 
)
inline

◆ ~ArrayHandleUniformPointCoordinates()

vtkm::cont::ArrayHandleUniformPointCoordinates::~ArrayHandleUniformPointCoordinates ( )
inline

Implemented so that it is defined exclusively in the control environment.

If there is a separate device for the execution environment (for example, with CUDA), then the automatically generated destructor could be created for all devices, and it would not be valid for all devices.

Member Function Documentation

◆ VTKM_ARRAY_HANDLE_SUBCLASS_NT()

vtkm::cont::ArrayHandleUniformPointCoordinates::VTKM_ARRAY_HANDLE_SUBCLASS_NT ( ArrayHandleUniformPointCoordinates  ,
(vtkm::cont::ArrayHandle< vtkm::Vec3f, vtkm::cont::StorageTagUniformPoints >)   
)

The documentation for this class was generated from the following file: