VTK  9.1.0
Public Member Functions | Public Attributes | List of all members
vtx::types::DataArray Class Reference

#include <VTXDataArray.h>

Collaboration diagram for vtx::types::DataArray:
[legend]

Public Member Functions

 DataArray ()=default
 
 ~DataArray ()=default
 
bool IsScalar () const noexcept
 
void ConvertTo3DVTK (const std::vector< double > &fillValues=std::vector< double >())
 Convert internal vtkDataArray to a 3D VTK conforming array number of components = 3 filling the values of absent coordinates with the input fillValues (default = 0) More...
 

Public Attributes

std::vector< std::string > VectorVariables
 
vtkSmartPointer< vtkDataArrayData
 
adios2::Dims Shape
 
adios2::Dims Start
 
adios2::Dims Count
 
std::map< size_t, adios2::Dims > BlockCounts
 key: blockID, value: block count More...
 
bool IsIdType = false
 true : uses the special vtkIdType for indexing false : uses other VTK supported type More...
 
bool HasTuples = false
 true: tuples > 1, false: tuples = 1 More...
 
bool Persist = false
 true: if variable doesn't exist in a step don't attempt to read, use the latest known values. More...
 
bool IsUpdated = true
 true: new value is found and read, false: not updated More...
 
bool IsSOA = false
 true: is struct of arrays (*x, *y, *z) or (XXXX, YYYY, ZZZZ) false (default): is array of structs (xyz, xyz, xyz) common case More...
 

Detailed Description

Definition at line 39 of file VTXDataArray.h.

Constructor & Destructor Documentation

◆ DataArray()

vtx::types::DataArray::DataArray ( )
default

◆ ~DataArray()

vtx::types::DataArray::~DataArray ( )
default

Member Function Documentation

◆ IsScalar()

bool vtx::types::DataArray::IsScalar ( ) const
noexcept

◆ ConvertTo3DVTK()

void vtx::types::DataArray::ConvertTo3DVTK ( const std::vector< double > &  fillValues = std::vector< double >())

Convert internal vtkDataArray to a 3D VTK conforming array number of components = 3 filling the values of absent coordinates with the input fillValues (default = 0)

Parameters
fillValuesvalues to fill for missing coordinates

Member Data Documentation

◆ VectorVariables

std::vector<std::string> vtx::types::DataArray::VectorVariables

Definition at line 42 of file VTXDataArray.h.

◆ Data

vtkSmartPointer<vtkDataArray> vtx::types::DataArray::Data

Definition at line 43 of file VTXDataArray.h.

◆ Shape

adios2::Dims vtx::types::DataArray::Shape

Definition at line 46 of file VTXDataArray.h.

◆ Start

adios2::Dims vtx::types::DataArray::Start

Definition at line 47 of file VTXDataArray.h.

◆ Count

adios2::Dims vtx::types::DataArray::Count

Definition at line 48 of file VTXDataArray.h.

◆ BlockCounts

std::map<size_t, adios2::Dims> vtx::types::DataArray::BlockCounts

key: blockID, value: block count

Definition at line 52 of file VTXDataArray.h.

◆ IsIdType

bool vtx::types::DataArray::IsIdType = false

true : uses the special vtkIdType for indexing false : uses other VTK supported type

Definition at line 56 of file VTXDataArray.h.

◆ HasTuples

bool vtx::types::DataArray::HasTuples = false

true: tuples > 1, false: tuples = 1

Definition at line 59 of file VTXDataArray.h.

◆ Persist

bool vtx::types::DataArray::Persist = false

true: if variable doesn't exist in a step don't attempt to read, use the latest known values.

Common case: mesh variables false: attempt to read always

Definition at line 66 of file VTXDataArray.h.

◆ IsUpdated

bool vtx::types::DataArray::IsUpdated = true

true: new value is found and read, false: not updated

Definition at line 69 of file VTXDataArray.h.

◆ IsSOA

bool vtx::types::DataArray::IsSOA = false

true: is struct of arrays (*x, *y, *z) or (XXXX, YYYY, ZZZZ) false (default): is array of structs (xyz, xyz, xyz) common case

Definition at line 75 of file VTXDataArray.h.


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