Go to the documentation of this file.
10 #ifndef vtk_m_cont_Field_h
11 #define vtk_m_cont_Field_h
98 template <
typename T,
typename Storage>
118 return this->FieldAssociation == Association::WholeDataSet;
122 return this->FieldAssociation == Association::Partitions;
201 template <
typename T,
typename StorageTag>
208 virtual void PrintSummary(std::ostream& out)
const;
213 this->Data.ReleaseResourcesExecution();
214 this->
Range.ReleaseResourcesExecution();
223 mutable bool ModifiedFlag =
true;
226 template <
typename Functor,
typename... Args>
234 template <
typename T>
245 template <
typename T>
248 const std::vector<T>& data,
254 template <
typename T>
257 std::vector<T>&& data)
262 template <
typename T>
265 std::vector<T>&& data,
271 template <
typename T>
274 std::initializer_list<T>&& data)
282 template <
typename T,
typename S>
296 template <
typename T,
typename S>
321 struct DynamicTransformTraits<
vtkm::cont::Field>
323 using DynamicTag = vtkm::cont::internal::DynamicTransformTagCastAndCall;
346 #endif //vtk_m_cont_Field_h
Manages an array-worth of data.
Definition: ArrayHandle.h:300
T load(const U &u, vtkm::Id v)
Definition: FetchTagArrayDirectIn.h:36
Groups connected points that have the same field value.
Definition: Atomic.h:19
bool IsCellField() const
Definition: Field.h:114
Association
Identifies what elements of a data set a field is associated with.
Definition: Field.h:38
vtkm::cont::Field make_Field(std::string name, Field::Association association, const T *data, vtkm::Id size, vtkm::CopyFlag copy)
Convenience functions to build fields from C style arrays and std::vector.
Definition: Field.h:236
An ArrayHandle of an unknown value type and storage.
Definition: UnknownArrayHandle.h:430
vtkm::cont::ArrayHandle< vtkm::Range > Range
Definition: Field.h:222
vtkm::cont::ArrayHandleBasic< T > make_ArrayHandleMove(T *&array, vtkm::Id numberOfValues, vtkm::cont::internal::BufferInfo::Deleter deleter=internal::SimpleArrayDeleter< T >, vtkm::cont::internal::BufferInfo::Reallocater reallocater=internal::SimpleArrayReallocater< T >)
A convenience function to move a user-allocated array into an ArrayHandle.
Definition: ArrayHandleBasic.h:249
std::string Name
name of field
Definition: Field.h:218
void CastAndCall(const DynamicObject &dynamicObject, Functor &&f, Args &&... args)
A Generic interface to CastAndCall.
Definition: CastAndCall.h:47
bool IsPartitionsField() const
Definition: Field.h:120
Definition: Particle.h:351
const vtkm::cont::UnknownArrayHandle & GetData() const
Field(std::string name, Association association, const vtkm::cont::ArrayHandle< T, Storage > &data)
Definition: Field.h:99
vtkm::cont::UnknownArrayHandle Data
Definition: Field.h:221
vtkm::cont::Field make_FieldCell(std::string name, const vtkm::cont::ArrayHandle< T, S > &data)
Convenience function to build cell fields from vtkm::cont::ArrayHandle.
Definition: Field.h:297
virtual void ReleaseResourcesExecution()
Definition: Field.h:211
A Field encapsulates an array on some piece of the mesh, such as the points, a cell set,...
Definition: Field.h:31
#define VTKM_CONT_EXPORT
Definition: vtkm_cont_export.h:44
@ Points
A field that applies to points.
#define VTKM_CONT
Definition: ExportMacros.h:57
vtkm::Int64 Id
Base type to use to index arrays.
Definition: Types.h:227
bool IsGlobalField() const
Definition: Field.h:124
#define vtkmNotUsed(parameter_name)
Simple macro to identify a parameter as unused.
Definition: ExportMacros.h:128
const std::string & GetName() const
Definition: Field.h:132
bool IsWholeDataSetField() const
Definition: Field.h:116
bool IsPointField() const
Definition: Field.h:115
void SetData(const vtkm::cont::ArrayHandle< T, StorageTag > &newdata)
Definition: Field.h:202
@ Cells
A field that applies to cells.
CopyFlag
Identifier used to specify whether a function should deep copy data.
Definition: Flags.h:17
vtkm::cont::ArrayHandleBasic< T > make_ArrayHandle(const T *array, vtkm::Id numberOfValues, vtkm::CopyFlag copy)
A convenience function for creating an ArrayHandle from a standard C array.
Definition: ArrayHandleBasic.h:225
vtkm::cont::Field make_FieldMove(std::string name, Field::Association association, std::vector< T > &&data)
Definition: Field.h:255
vtkm::cont::Field make_FieldPoint(std::string name, const vtkm::cont::ArrayHandle< T, S > &data)
Convenience function to build point fields from vtkm::cont::ArrayHandle.
Definition: Field.h:283
Association GetAssociation() const
Definition: Field.h:133
vtkm::Id GetNumberOfValues() const
Definition: Field.h:130
Represent a continuous scalar range of values.
Definition: Range.h:31