## On this page # DVS::IElementBlock Class Reference Last update: 16.07.2025 `#include <dvs_element_block_interface.h>` Inheritance diagram for DVS::IElementBlock: ![](/sites/default/files/migrate-content/postprocessing_2025_r1_1/class_d_v_s_1_1_i_element_block.png) ## Public Member Functions **IElementBlock** ()=default virtual **~IElementBlock** ()=default **IElementBlock** ([IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) &&)=default [IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) & **operator=** ([IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) &&)=default **IElementBlock** (const [IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) &)=default [IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) & **operator=** (const [IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) &)=default virtual [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) [get\_element\_type](#aebec4b30e0b8dcb53b4b34305fa0d61e) () const =0 virtual bool [get\_is\_ghost](#a01c36edfb491803556b3f30483339d26) () const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_num\_variables](#a8c8e7ec1c08a472a4dcfa56cd69568d3) (uint32\_t &num\_vars, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml) \* [get\_variable](#a16ed2ca6ad45b9ffb78002f95cfbf0e5) (uint32\_t index, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_size](#a452ed02842ece58d57c2abba34bd66ab) (uint32\_t index, uint32\_t &num\_values, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_size](#a1c24a51dcdd6053e1b506aa5e61d79e5) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, uint32\_t &num\_values) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](#a3e7a946f3e97334f2a2ec72fd23e0e6e) (uint32\_t index, float \*array) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](#ab60ef11cb6c4991c62fe59f71ad6bc78) (uint32\_t index, int64\_t \*array) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](#ad5c88d1a1d172caedabe84a8f302b9f2) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, float \*array) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](#aef1f01f7fd80effeeb12af064c751f01) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, int64\_t \*array) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](#a0bc52709b9440da6848d2b18751f51f4) (uint32\_t index, uint32\_t \*num\_values, float \*array)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](#aff20dc24794c5dfdfe009fce86f79659) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, uint32\_t \*num\_values, float \*array)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_nodes\_per\_element](#ab95989900765aabb0eccefbe8c25fedd) (uint32\_t &nodes\_per\_element) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_num\_elements](#a74e15d2c0471232fca5dda950cd5dcbb) (uint32\_t &num\_elements) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_connectivity\_size](#a310ce04445517dd10942e7ba224ac75d) (uint32\_t &indices\_size)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_connectivity](#a78959ba4b322598b6bb31fc205c0d3b7) (uint32\_t \*indices)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_connectivity\_polygon\_size](#a21ddc1624e91860b6dd37c25d7bd333f) (uint32\_t &nodes\_per\_polygon\_size, uint32\_t &indices\_size)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_connectivity\_polygon](#a6b03d65937d395bbf9819e15b9c83288) (uint32\_t \*nodes\_per\_polygon, uint32\_t \*indices)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_connectivity\_polyhedral\_size](#aa9bc1541ae8c5114f133122dbbb247cd) (uint32\_t &faces\_per\_element\_size, uint32\_t &nodes\_per\_face\_size, uint32\_t &indices\_size)=0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_connectivity\_polyhedral](#ab47ae0f50ceab792a872a47a867134e5) (uint32\_t \*faces\_per\_element, uint32\_t \*nodes\_per\_face, uint32\_t \*indices)=0 ![-](/sites/default/files/migrate-content/postprocessing_2025_r1_1/closed.png) Public Member Functions inherited from [DVS::IHash](class_d_v_s_1_1_i_hash.xhtml) **IHash** ()=default virtual **~IHash** ()=default **IHash** ([IHash](class_d_v_s_1_1_i_hash.xhtml) &&)=default [IHash](class_d_v_s_1_1_i_hash.xhtml) & **operator=** ([IHash](class_d_v_s_1_1_i_hash.xhtml) &&)=default **IHash** (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &)=default [IHash](class_d_v_s_1_1_i_hash.xhtml) & **operator=** (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &)=default virtual uint32\_t [get\_hash\_size](class_d_v_s_1_1_i_hash.xhtml#ac0dedeb8d9dfd442d49d16cb4ddfb221) () const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_hash](class_d_v_s_1_1_i_hash.xhtml#a51eaee86a6e2db4dda7f4326daa33874) (char \*hash) const =0 ![-](/sites/default/files/migrate-content/postprocessing_2025_r1_1/closed.png) Public Member Functions inherited from [DVS::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) **IVarHash** ()=default virtual **~IVarHash** ()=default **IVarHash** ([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &&)=default [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) & **operator=** ([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &&)=default **IVarHash** (const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &)=default [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) & **operator=** (const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &)=default virtual uint32\_t [get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#a85c3ade756029207e15b1c8de8cd5c1b) (uint32\_t index, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual uint32\_t [get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#a81cd99bbf69ccc0d50e8bcb7dd291046) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a17fff1548eb276edd326a0af08f6a7c4) (uint32\_t index, char \*hash, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a7348be86da47ac034252a68949b21007) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, char \*hash) const =0 ## Detailed Description Element blocks contain the connectivity and variable data for elements. There is one element block per element type the mesh block has data available for. Note: Structured data's connectivity is implicit and the element block only contains variable information for elements. Structured data is also different for ghost elements as the ghost elements are represented as an elemental variable instead of as an element block as unstructured data represents it. We might want to change this in future versions so structured data is better aligned with unstructured data in DVS but currently this is how the information is represented. See [DVS::IHash](class_d_v_s_1_1_i_hash.xhtml "Interface to get hash information from DVS objects.") and [DVS::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml "Interface to get variable hash information from DVS objects.") for the hash object interface. Definition at line [51](dvs__element__block__interface_8h_source.xhtml#l00051) of file [dvs\_element\_block\_interface.h](dvs__element__block__interface_8h_source.xhtml). ## Member Function Documentation ## [◆ ](#a78959ba4b322598b6bb31fc205c0d3b7)get\_connectivity() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_connectivity ( uint32\_t \* *indices*) pure virtual Get the connectivity for basic unstructured element types. This method returns the connectivity array for a basic unstructured element. If retrieving the indices array it should be of size indices\_size returned from [get\_connectivity\_size()](#a310ce04445517dd10942e7ba224ac75d "Get the size of the connectivity array."). Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: This element block is not a basic unstructured type - DVS\_INVALID\_CACHE: Loading cache failed, possibly invalid cache or invalid permissions - DVS\_DATA\_FAILED\_LOAD: There was a failure loading data, data is either empty or missing Parameters \[out\]indicesIf not nullptr should be of size indices\_size from [get\_connectivity\_size()](#a310ce04445517dd10942e7ba224ac75d "Get the size of the connectivity array.") Returnsdvs\_ret DVS\_NONE on no error, see the method documentation for errors ## [◆ ](#a6b03d65937d395bbf9819e15b9c83288)get\_connectivity\_polygon() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_connectivity\_polygon ( uint32\_t \* *nodes\_per\_polygon*, uint32\_t \* *indices* ) pure virtual Get the connectivity information for polygonal element blocks. This method returns the different connectivity arrays for polygonal elements. The size of the arrays to allocate should be retrieved through the method [get\_connectivity\_polygon\_size()](#a21ddc1624e91860b6dd37c25d7bd333f "Get the size of the connectivity arrays for polygon elements."). Polygonal elements are described by 2 arrays. nodes\_per\_polygon is the number of nodes for each element. indices is the connectivity array for each element. So a square might look like: nodes\_per\_polygon: \[4\] (of size 1) indices: \[0, 1, 2, 3\] (of size 4) Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: This element block is not a basic unstructured type - DVS\_INVALID\_CACHE: Loading cache failed, possibly invalid cache or invalid permissions - DVS\_DATA\_FAILED\_LOAD: There was a failure loading data, data is either empty or missing Parameters \[out\]nodes\_per\_polygonan ouput array of size nodes\_per\_polygon\_size from [get\_connectivity\_polygon\_size()](#a21ddc1624e91860b6dd37c25d7bd333f "Get the size of the connectivity arrays for polygon elements.") \[out\]indicesan output array of size indices\_size from [get\_connectivity\_polygon\_size()](#a21ddc1624e91860b6dd37c25d7bd333f "Get the size of the connectivity arrays for polygon elements.") Returnsdvs\_ret DVS\_NONE on no error, see the method documentation for errors ## [◆ ](#a21ddc1624e91860b6dd37c25d7bd333f)get\_connectivity\_polygon\_size() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_connectivity\_polygon\_size ( uint32\_t & *nodes\_per\_polygon\_size*, uint32\_t & *indices\_size* ) pure virtual Get the size of the connectivity arrays for polygon elements. This method returns the size of the connectivity arrays for polygon elements. This should be used to allocate array sizes for use with [get\_connectivity\_polygon()](#a6b03d65937d395bbf9819e15b9c83288 "Get the connectivity information for polygonal element blocks."). nodes\_per\_polygon\_size is the total number of elements for this element type indices\_size is the size of the total connectivity array Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: This element block is not a basic unstructured type Parameters \[out\]nodes\_per\_polygon\_sizethe number of nodes per polygon, this is also the total number of elements \[out\]indices\_sizethe total size of the connectivity array Returnsdvs\_ret DVS\_NONE on no error, see the method documentation for errors ## [◆ ](#ab47ae0f50ceab792a872a47a867134e5)get\_connectivity\_polyhedral() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_connectivity\_polyhedral ( uint32\_t \* *faces\_per\_element*, uint32\_t \* *nodes\_per\_face*, uint32\_t \* *indices* ) pure virtual Get the connectivity information for polyhedral element blocks. This method returns the different connectivity arrays for polyhedral elements. The size of the arrays to allocate should be retrieved through the method [get\_connectivity\_polygon\_size()](#a21ddc1624e91860b6dd37c25d7bd333f "Get the size of the connectivity arrays for polygon elements."). Polyhedral elements are described by 3 arrays. faces\_per\_element is the number of faces each individual element is made up of. Nodes per face is the number of nodes within each respective face. And the indices array of the connectivity of each face. So a cube might look like: faces\_per\_element: \[6\] (of size 1) nodes\_per\_face: \[4,4,4,4,4,4\] (of size 6) indices: \[0,1,2,3 ..... \] (of size 24) Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: This element block is not a basic unstructured type - DVS\_INVALID\_CACHE: Loading cache failed, possibly invalid cache or invalid permissions - DVS\_DATA\_FAILED\_LOAD: There was a failure loading data, data is either empty or missing Parameters \[out\]faces\_per\_elementand output array of size faces\_per\_element\_size from [get\_connectivity\_polyhedral\_size()](#aa9bc1541ae8c5114f133122dbbb247cd "Get size of the connectivity arrays for polyhedral elements.") \[out\]nodes\_per\_facean output array of size nodes\_per\_face\_size from [get\_connectivity\_polyhedral\_size()](#aa9bc1541ae8c5114f133122dbbb247cd "Get size of the connectivity arrays for polyhedral elements.") \[out\]indicesan output array of size indices\_size from [get\_connectivity\_polyhedral\_size()](#aa9bc1541ae8c5114f133122dbbb247cd "Get size of the connectivity arrays for polyhedral elements.") Returnsdvs\_ret DVS\_NONE on no error, see the method documentation for errors ## [◆ ](#aa9bc1541ae8c5114f133122dbbb247cd)get\_connectivity\_polyhedral\_size() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_connectivity\_polyhedral\_size ( uint32\_t & *faces\_per\_element\_size*, uint32\_t & *nodes\_per\_face\_size*, uint32\_t & *indices\_size* ) pure virtual Get size of the connectivity arrays for polyhedral elements. This method returns the size of the connectivity arrays for polyhedral elements. This should be used to allocate array sizes for use with [get\_connectivity\_polyhedral()](#ab47ae0f50ceab792a872a47a867134e5 "Get the connectivity information for polyhedral element blocks."). Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: This element block is not a basic unstructured type Parameters \[out\]faces\_per\_element\_sizethe number of faces per element, this is also the total number of elements \[out\]nodes\_per\_face\_sizethe number of nodes for each face in an element \[out\]indices\_sizethe total number of indices in the connectivity array Returnsdvs\_ret DVS\_NONE on no error, see the method documentation for errors ## [◆ ](#a310ce04445517dd10942e7ba224ac75d)get\_connectivity\_size() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_connectivity\_size ( uint32\_t & *indices\_size*) pure virtual Get the size of the connectivity array. This method returns the size of the connectivity array in the param indices\_size. This should be used to get the connectivity via [get\_connectivity()](#a78959ba4b322598b6bb31fc205c0d3b7 "Get the connectivity for basic unstructured element types.") Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: This element block is not a basic unstructured type Parameters \[out\]indices\_sizethe size of the connectivity array for this element block Returnsdvs\_ret DVS\_NONE on no error, see the method documentation for errors ## [◆ ](#aebec4b30e0b8dcb53b4b34305fa0d61e)get\_element\_type() virtual [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) DVS::IElementBlock::get\_element\_type ( ) const pure virtual Get the element type for this block. Returnsdvs\_element\_type the element type for this block ## [◆ ](#a01c36edfb491803556b3f30483339d26)get\_is\_ghost() virtual bool DVS::IElementBlock::get\_is\_ghost ( ) const pure virtual Get if this element block is composed of ghost elements. This method returns if the element block is composed of ghost elements. Note: This is only for unstructured data, structured data ghost elements are stored within an elemental variable (DVS\_STRUCTURED\_GHOST\_ELEMENTS) Returnstrue if unstructured ghost elements ## [◆ ](#ab95989900765aabb0eccefbe8c25fedd)get\_nodes\_per\_element() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_nodes\_per\_element ( uint32\_t & *nodes\_per\_element*) const pure virtual Get the number of nodes per basic unstructured element. This method is invalid for polygonal and polyhedral elements Error Codes: - DVS\_NONE: No error - DVS\_INVALID\_ELEMENT\_TYPE: Returned for polygonal/polyhedral data - DVS\_UNKNOWN: Unknown new type, should not happen Parameters \[out\]nodes\_per\_elementthe number of nodes per element Returnsdvs\_ret DVS\_NONE on no error, otherwise see method documentation ## [◆ ](#a74e15d2c0471232fca5dda950cd5dcbb)get\_num\_elements() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_num\_elements ( uint32\_t & *num\_elements*) const pure virtual Get the number of elements for this block. Parameters \[out\]num\_elementsthe number of elements for this block Returnsdvs\_ret DVS\_NONE on no error ## [◆ ](#a8c8e7ec1c08a472a4dcfa56cd69568d3)get\_num\_variables() virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_num\_variables ( uint32\_t & *num\_vars*, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) *type* = VAR\_TYPE::FLOAT ) const pure virtual Get the number of elemental variables this element block has data for. This method is intended to be used in conjunction with [get\_variable()](#a16ed2ca6ad45b9ffb78002f95cfbf0e5 "Get the variable definition associates with the elemental variable for this index.") and [get\_variable\_data()](#a3e7a946f3e97334f2a2ec72fd23e0e6e "Get the variable data by index.") to retrieve elemental variable data. Errors: - DVS\_NONE: Success Parameters \[out\]num\_varsif success, returns the number of variables on this element block \[in\]typethe enum type. By default, VAR\_TYPE::FLOAT ReturnsDVS\_NONE on success, else see method description ## [◆ ](#a16ed2ca6ad45b9ffb78002f95cfbf0e5)get\_variable() virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml) \* DVS::IElementBlock::get\_variable ( uint32\_t *index*, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) *type* = VAR\_TYPE::FLOAT ) const pure virtual Get the variable definition associates with the elemental variable for this index. This method retrieves the variable that is associated with the elemental variable of the mesh chunk at a specific index in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] Parameters \[in\]indexindex of variable definition to get in range \[0, [get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] \[in\]typethe enum type. By default, VAR\_TYPE::FLOAT Returns[DVS::IVar](class_d_v_s_1_1_i_var.xhtml "Interface for variables for the DVS Reader API.")\* nullptr if out of range, otherwise the variable associated with the index ## [◆ ](#ad5c88d1a1d172caedabe84a8f302b9f2)get\_variable\_data() \[1/6\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_data ( const [IVar](class_d_v_s_1_1_i_var.xhtml) \* *var*, float \* *array* ) const pure virtual Get the variable data by variable. This method retrieves the nodal variable data based on a specific variable definitions. Error Codes: - DVS\_NONE: No error - DVS\_PARAM\_INVALID\_VAR: Bad (or null) variable object passed into method - DVS\_PARAM\_INVALID\_VAR\_ID: Mesh chunk does not have data for var passed in. - DVS\_PARAM\_NULL: All parameters are null. Method will do nothing. - DVS\_INVALID\_CACHE: Cache is unable to be read. Bad location or permissions - DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data - DVS\_DATA\_FAILED\_LOAD: Data hash in metadata is missing from blockstore. Bad cache or permissions? Parameters \[in\]varthe variable definition to retrieve nodal variable data for \[out\]arrayan array whose size should be returned from [get\_variable\_size()](#a452ed02842ece58d57c2abba34bd66ab "Get the variable size via the index and specified type."). Overloaded for float and int64. Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#aef1f01f7fd80effeeb12af064c751f01)get\_variable\_data() \[2/6\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_data ( const [IVar](class_d_v_s_1_1_i_var.xhtml) \* *var*, int64\_t \* *array* ) const pure virtual Get the variable data by variable. This method retrieves the nodal variable data based on a specific variable definitions. Error Codes: - DVS\_NONE: No error - DVS\_PARAM\_INVALID\_VAR: Bad (or null) variable object passed into method - DVS\_PARAM\_INVALID\_VAR\_ID: Mesh chunk does not have data for var passed in. - DVS\_PARAM\_NULL: All parameters are null. Method will do nothing. - DVS\_INVALID\_CACHE: Cache is unable to be read. Bad location or permissions - DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data - DVS\_DATA\_FAILED\_LOAD: Data hash in metadata is missing from blockstore. Bad cache or permissions? Parameters \[in\]varthe variable definition to retrieve nodal variable data for \[out\]arrayan array whose size should be returned from [get\_variable\_size()](#a452ed02842ece58d57c2abba34bd66ab "Get the variable size via the index and specified type."). Overloaded for float and int64. Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#aff20dc24794c5dfdfe009fce86f79659)get\_variable\_data() \[3/6\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_data ( const [IVar](class_d_v_s_1_1_i_var.xhtml) \* *var*, uint32\_t \* *num\_values*, float \* *array* ) pure virtual Get the variable data on this mesh chunk by by variable definition. This method retrieves the elemental variable data based on a specific variable definitions. Error Codes: - DVS\_NONE: No error - DVS\_PARAM\_INVALID\_VAR: Bad (or null) variable object passed into method - DVS\_PARAM\_INVALID\_VAR\_ID: Mesh chunk does not have data for var passed in. - DVS\_PARAM\_NULL: All parameters are null. Method will do nothing. - DVS\_INVALID\_CACHE: Cache is unable to be read. Bad location or permissions - DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data - DVS\_DATA\_FAILED\_LOAD: Data hash in metadata is missing from blockstore. Bad cache or permissions? Parameters \[in\]varthe variable definition to retrieve elemental variable data for \[out\]num\_valuesif not nullptr returns the number of values to allocate for array \[out\]arrayif not nullptr should be of size num\_values Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#a3e7a946f3e97334f2a2ec72fd23e0e6e)get\_variable\_data() \[4/6\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_data ( uint32\_t *index*, float \* *array* ) const pure virtual Get the variable data by index. This method retrieves nodal variable data based on an index in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\]. To retrieve the variable definition associated with the index call [get\_variable()](#a16ed2ca6ad45b9ffb78002f95cfbf0e5 "Get the variable definition associates with the elemental variable for this index."). Error Codes: - DVS\_NONE: No error - DVS\_PARAM\_NULL: All parameters are null. Method will do nothing. - DVS\_PARAM\_OUT\_OF\_BOUNDS: Index out of bounds of \[0, [get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] - DVS\_PARAM\_INVALID\_VAR: Invalid variable found at index, should not happen - DVS\_PARAM\_INVALID\_VAR\_ID: Invalid variable id found at index, should not happen - DVS\_INVALID\_CACHE: Cache is unable to be read. Bad location or permissions - DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data - DVS\_DATA\_FAILED\_LOAD: Data hash in metadata is missing from blockstore. Bad cache or permissions? Parameters \[in\]indexindex of the variable data in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] \[out\]arrayan array whose size should be returned from [get\_variable\_size()](#a452ed02842ece58d57c2abba34bd66ab "Get the variable size via the index and specified type."). Overloaded for float and int64. Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#ab60ef11cb6c4991c62fe59f71ad6bc78)get\_variable\_data() \[5/6\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_data ( uint32\_t *index*, int64\_t \* *array* ) const pure virtual Get the variable data by index. This method retrieves nodal variable data based on an index in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\]. To retrieve the variable definition associated with the index call [get\_variable()](#a16ed2ca6ad45b9ffb78002f95cfbf0e5 "Get the variable definition associates with the elemental variable for this index."). Error Codes: - DVS\_NONE: No error - DVS\_PARAM\_NULL: All parameters are null. Method will do nothing. - DVS\_PARAM\_OUT\_OF\_BOUNDS: Index out of bounds of \[0, [get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] - DVS\_PARAM\_INVALID\_VAR: Invalid variable found at index, should not happen - DVS\_PARAM\_INVALID\_VAR\_ID: Invalid variable id found at index, should not happen - DVS\_INVALID\_CACHE: Cache is unable to be read. Bad location or permissions - DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data - DVS\_DATA\_FAILED\_LOAD: Data hash in metadata is missing from blockstore. Bad cache or permissions? Parameters \[in\]indexindex of the variable data in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] \[out\]arrayan array whose size should be returned from [get\_variable\_size()](#a452ed02842ece58d57c2abba34bd66ab "Get the variable size via the index and specified type."). Overloaded for float and int64. Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#a0bc52709b9440da6848d2b18751f51f4)get\_variable\_data() \[6/6\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_data ( uint32\_t *index*, uint32\_t \* *num\_values*, float \* *array* ) pure virtual Get the variable data on this mesh chunk by index. This method retrieves elemental variable data based on an index in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\]. To retrieve the variable definition associated with the index call [get\_variable()](#a16ed2ca6ad45b9ffb78002f95cfbf0e5 "Get the variable definition associates with the elemental variable for this index."). Error Codes: - DVS\_NONE: No error - DVS\_PARAM\_NULL: All parameters are null. Method will do nothing. - DVS\_PARAM\_OUT\_OF\_BOUNDS: Index out of bounds of \[0, [get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] - DVS\_PARAM\_INVALID\_VAR: Invalid variable found at index, should not happen - DVS\_PARAM\_INVALID\_VAR\_ID: Invalid variable id found at index, should not happen - DVS\_INVALID\_CACHE: Cache is unable to be read. Bad location or permissions - DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data - DVS\_DATA\_FAILED\_LOAD: Data hash in metadata is missing from blockstore. Bad cache or permissions? Parameters \[in\]indexindex of the variable data in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] \[out\]num\_valuesif not nullptr returns the number of values to allocate for array \[out\]arrayif not nullptr must be of size num\_values Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#a1c24a51dcdd6053e1b506aa5e61d79e5)get\_variable\_size() \[1/2\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_size ( const [IVar](class_d_v_s_1_1_i_var.xhtml) \* *var*, uint32\_t & *num\_values* ) const pure virtual Get the variable size by variable. This method retrieves the nodal variable data size based on a specific variable definitions. Error Codes: - DVS\_NONE: Success - DVS\_PARAM\_INVALID\_VAR: Bad (or null) variable object passed into method Parameters \[in\]varthe variable definition to retrieve nodal variable data for \[out\]num\_valuesa reference to a uint32\_t, representing the number of values of the variable Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description ## [◆ ](#a452ed02842ece58d57c2abba34bd66ab)get\_variable\_size() \[2/2\] virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IElementBlock::get\_variable\_size ( uint32\_t *index*, uint32\_t & *num\_values*, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) *type* = VAR\_TYPE::FLOAT ) const pure virtual Get the variable size via the index and specified type. This method retrieves the variable's size that is associated with the nodal variable of the mesh chunk at a specific index in range \[0,[get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] and of the specified type Errors: - DVS\_NONE: Success Parameters \[in\]indexindex of variable definition to get in range \[0, [get\_num\_variables()](#a8c8e7ec1c08a472a4dcfa56cd69568d3 "Get the number of elemental variables this element block has data for.")-1\] \[out\]num\_valuesa reference to a uint32\_t, representing the number of values of the variable \[in\]typethe enum type. By default, VAR\_TYPE::FLOAT Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description --- The documentation for this class was generated from the following file:- D:/ANSYSDev/Product-src/ensight/user\_defined\_src/readers/dvs/include/[dvs\_element\_block\_interface.h](dvs__element__block__interface_8h_source.xhtml)