    

 ## On this page

  

 

 # DVS::IMeshChunk Class Reference

 Last update: 16.07.2025 

Mesh Chunk Interface for DVS Reader API. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#details)

`#include <<a class="el" href="dvs__mesh__chunk__interface_8h_source.xhtml">dvs_mesh_chunk_interface.h</a>>`

Inheritance diagram for DVS::IMeshChunk:

 ![](/sites/default/files/migrate-content/tools_for_ensight_post_processing_import/class_d_v_s_1_1_i_mesh_chunk.png)



## <a id="pub-types" name="pub-types"></a>Public Types

enum [MeshType](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144a) { [UNKNOWN](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144aaa98ab1208c4de624d1af2488ea342b15) = 0 , [UNSTRUCTURED](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144aabd8a1a2f952443e439d96cbea674208e) = 1 , [PARALLELEPIPED](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144aa95416cf06dfb48f6331a1f7c5c2704d2) = 2 , [CURVILINEAR](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144aab7e091dc6959aa447a0b6a44be352013) = 3 } The different mesh types allowed. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144a)  
 enum [Axis](class_d_v_s_1_1_i_mesh_chunk.xhtml#a37105a87f7c965d7519eb02f4f63c3d8) { [X](class_d_v_s_1_1_i_mesh_chunk.xhtml#a37105a87f7c965d7519eb02f4f63c3d8a5f586336dff689b95a213ae63d5d971d) = 0 , [Y](class_d_v_s_1_1_i_mesh_chunk.xhtml#a37105a87f7c965d7519eb02f4f63c3d8aa51d837ff28664b76eb076c405cad710) = 1 , [Z](class_d_v_s_1_1_i_mesh_chunk.xhtml#a37105a87f7c965d7519eb02f4f63c3d8a91a3b034071a3ac6c0da72aaac13f1ed) = 2 } The AXIS or IJK component to request. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a37105a87f7c965d7519eb02f4f63c3d8)  
 ## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

<a id="a6cc89750bc8c47e7a70c6cbfe48b0b61"></a> [IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml#a6cc89750bc8c47e7a70c6cbfe48b0b61) ()=default default   
 <a id="a04a72e7afdfd35926aa815b2c9178e0c"></a>virtual [~IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml#a04a72e7afdfd35926aa815b2c9178e0c) ()=default default   
 <a id="a7797bab216c4358dfb3c834e95e35376"></a> [IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7797bab216c4358dfb3c834e95e35376) ([IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml) &amp;&amp;)=default default   
 <a id="a06c8fb0442781d095c01bc14c5bee70b"></a>[IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml) &amp; [operator=](class_d_v_s_1_1_i_mesh_chunk.xhtml#a06c8fb0442781d095c01bc14c5bee70b) ([IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml) &amp;&amp;)=default default   
 <a id="a920089a626f93778aa3c1f0ab8e3f1d1"></a> [IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml#a920089a626f93778aa3c1f0ab8e3f1d1) (const [IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml) &amp;)=default support copying   
 <a id="a20253170d8ab94d0840ff6cec279b59c"></a>[IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml) &amp; [operator=](class_d_v_s_1_1_i_mesh_chunk.xhtml#a20253170d8ab94d0840ff6cec279b59c) (const [IMeshChunk](class_d_v_s_1_1_i_mesh_chunk.xhtml) &amp;)=default default   
 virtual [MeshType](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144a) [get\_type](class_d_v_s_1_1_i_mesh_chunk.xhtml#ab025d1550b2b3cd77faefecec5199852) () const =0 Get the type of mesh chunk. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#ab025d1550b2b3cd77faefecec5199852)  
 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* [get\_object](class_d_v_s_1_1_i_mesh_chunk.xhtml#ae4ff384a5739e480c88097bef524d4bd) () const =0 Get the object definiton this mesh chunk is associated with. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#ae4ff384a5739e480c88097bef524d4bd)  
 virtual float [get\_time](class_d_v_s_1_1_i_mesh_chunk.xhtml#a32ad562394805327fbabffa322643701) () const =0 Get the time for this mesh chunk. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a32ad562394805327fbabffa322643701)  
 virtual uint32\_t [get\_rank](class_d_v_s_1_1_i_mesh_chunk.xhtml#a6c520674083999e99bdf77b2b1eaacf8) () const =0 Get the rank for the mesh chunk. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a6c520674083999e99bdf77b2b1eaacf8)  
 virtual uint32\_t [get\_chunk](class_d_v_s_1_1_i_mesh_chunk.xhtml#a6b894c57bfd1e70168290ce69ecc5af4) () const =0 Get the chunk for this mesh chunk. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a6b894c57bfd1e70168290ce69ecc5af4)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_size](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53) (uint32\_t &amp;component\_size)=0 Get the size of each coordinate component for unstructured meshes. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7738e954570e849462ff493ec875bc80) (float \*x\_coords, float \*y\_coords, float \*z\_coords)=0 Get the coordinates for an unstructured mesh. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7738e954570e849462ff493ec875bc80)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_interleaved](class_d_v_s_1_1_i_mesh_chunk.xhtml#a39c2d8cc95f14ecbe9789908881c92a0) (float \*coords)=0 Get the coords for a unstructured meshes interleaved in a single array. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a39c2d8cc95f14ecbe9789908881c92a0)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_curv\_size](class_d_v_s_1_1_i_mesh_chunk.xhtml#a70b1069fc8737730efa0fc01a0698fbd) (uint32\_t &amp;component\_size)=0 Get the size of each coordinate component for structured curvilinear meshes. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a70b1069fc8737730efa0fc01a0698fbd)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_curv](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8da90ca355541bf876fa23ed267f94cb) (float local\_ijk\_min\[3\], float local\_ijk\_max\[3\], float global\_ijk\_max\[3\], float \*x\_coords, float \*y\_coords, float \*z\_coords)=0 Get coordinate data for a structured curvilinear mesh. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8da90ca355541bf876fa23ed267f94cb)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_curv\_interleaved](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5c191e3ec6d65a527fc1f3224f84d503) (float local\_ijk\_min\[3\], float local\_ijk\_max\[3\], float global\_ijk\_max\[3\], float \*coords)=0 Get the coords for structured curvilinear meshes interleaved in a single array. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5c191e3ec6d65a527fc1f3224f84d503)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_parallele\_size](class_d_v_s_1_1_i_mesh_chunk.xhtml#abda21734e2f506b982b65007d17c92fd) (uint32\_t &amp;i\_vals\_size, uint32\_t &amp;j\_vals\_size, uint32\_t &amp;k\_vals\_size)=0 Get the size of each ijk component for structured parallelpiped meshes. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#abda21734e2f506b982b65007d17c92fd)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_coords\_parallele](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123) (float origin\[3\], float dir\_vec\_i\[3\], float dir\_vec\_j\[3\], float dir\_vec\_k\[3\], float local\_ijk\_min\[3\], float local\_ijk\_max\[3\], float global\_ijk\_max\[3\], float \*i\_vals, float \*j\_vals, float \*k\_vals)=0 Get the ijk mesh information for structured parallelepiped mesh chunks. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_num\_variables](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4) (uint32\_t &amp;num\_vars) const =0 Get the number of nodal variables this mesh chunk has data for. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4)  
 virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml) \* [get\_variable](class_d_v_s_1_1_i_mesh_chunk.xhtml#afd77fb928baa23c8c453f897e082f880) (uint32\_t index) const =0 Get the variable definition associates with the nodal variable for this index. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#afd77fb928baa23c8c453f897e082f880)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](class_d_v_s_1_1_i_mesh_chunk.xhtml#ab72dfdd09b4258da7de7308ef48cb1fc) (uint32\_t index, uint32\_t \*num\_values, float \*array)=0 Get the variable data by index. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#ab72dfdd09b4258da7de7308ef48cb1fc)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_variable\_data](class_d_v_s_1_1_i_mesh_chunk.xhtml#ada793fcafd36d800dc3c4249b193318c) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, uint32\_t \*num\_values, float \*array)=0 Get the variable data by variable. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#ada793fcafd36d800dc3c4249b193318c)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_num\_element\_blocks](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5f3772e845d3ffe73c4a6525d78ab2ad) (uint32\_t &amp;num\_elem\_blocks) const =0 Get the number of element blocks for this mesh chunk. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5f3772e845d3ffe73c4a6525d78ab2ad)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_element\_block\_types](class_d_v_s_1_1_i_mesh_chunk.xhtml#a44a916bcd71f4d6b33661b249d52c61b) ([dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) \*element\_types) const =0 Get an array of the element block types for this mesh chunk. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a44a916bcd71f4d6b33661b249d52c61b)  
 virtual [DVS::IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) \* [get\_element\_block](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5d8b6af69d5c31c0017be9c8f6c3b28f) (uint32\_t index)=0 Get the element block by index. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5d8b6af69d5c31c0017be9c8f6c3b28f)  
 virtual [DVS::IElementBlock](class_d_v_s_1_1_i_element_block.xhtml) \* [get\_element\_block\_by\_type](class_d_v_s_1_1_i_mesh_chunk.xhtml#a54b8d01348ef368966b49c1329e74b74) ([dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type)=0 Get the element block by element type. [More...](class_d_v_s_1_1_i_mesh_chunk.xhtml#a54b8d01348ef368966b49c1329e74b74)  
 ![-](/sites/default/files/migrate-content/tools_for_ensight_post_processing_import/closed.png) Public Member Functions inherited from [DVS::IHash](class_d_v_s_1_1_i_hash.xhtml)<a id="a2f73d1292c0162a03bd29e9094567a77"></a> [IHash](class_d_v_s_1_1_i_hash.xhtml#a2f73d1292c0162a03bd29e9094567a77) ()=default default   
 <a id="a2e08d37be2095880bcb7d77b365ebde3"></a>virtual [~IHash](class_d_v_s_1_1_i_hash.xhtml#a2e08d37be2095880bcb7d77b365ebde3) ()=default default   
 <a id="a41019f8e16b485b73c1a832df9c21665"></a> [IHash](class_d_v_s_1_1_i_hash.xhtml#a41019f8e16b485b73c1a832df9c21665) ([IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;&amp;)=default default   
 <a id="ac5648bfca884e7946ca52f2da177f872"></a>[IHash](class_d_v_s_1_1_i_hash.xhtml) &amp; [operator=](class_d_v_s_1_1_i_hash.xhtml#ac5648bfca884e7946ca52f2da177f872) ([IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;&amp;)=default default   
 <a id="a17952af3cbc7170e37f882b17e800b3f"></a> [IHash](class_d_v_s_1_1_i_hash.xhtml#a17952af3cbc7170e37f882b17e800b3f) (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;)=default support copying   
 <a id="a31c93a2f7434c7e478289086bbb031b0"></a>[IHash](class_d_v_s_1_1_i_hash.xhtml) &amp; [operator=](class_d_v_s_1_1_i_hash.xhtml#a31c93a2f7434c7e478289086bbb031b0) (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;)=default default   
 virtual uint32\_t [get\_hash\_size](class_d_v_s_1_1_i_hash.xhtml#ac0dedeb8d9dfd442d49d16cb4ddfb221) () const =0 Get the size of the hash to use with [IHash::get\_hash()](class_d_v_s_1_1_i_hash.xhtml#a51eaee86a6e2db4dda7f4326daa33874 "Get the hash of the data.") [More...](class_d_v_s_1_1_i_hash.xhtml#ac0dedeb8d9dfd442d49d16cb4ddfb221)  
 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 Get the hash of the data. [More...](class_d_v_s_1_1_i_hash.xhtml#a51eaee86a6e2db4dda7f4326daa33874)  
 ![-](/sites/default/files/migrate-content/tools_for_ensight_post_processing_import/closed.png) Public Member Functions inherited from [DVS::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)<a id="a9b1a7d92f3c9c67d25be7b2cc4658b95"></a> [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a9b1a7d92f3c9c67d25be7b2cc4658b95) ()=default default   
 <a id="a7b2a92106ec38f910d49a1c179419871"></a>virtual [~IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a7b2a92106ec38f910d49a1c179419871) ()=default default   
 <a id="ae9c19f92692dee9f5d287ebc6e059dfb"></a> [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#ae9c19f92692dee9f5d287ebc6e059dfb) ([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;&amp;)=default default   
 <a id="a46d459469b54c813d775f38b3e434699"></a>[IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp; [operator=](class_d_v_s_1_1_i_var_hash.xhtml#a46d459469b54c813d775f38b3e434699) ([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;&amp;)=default default   
 <a id="a056227972d92b22777ee19f60e1794f6"></a> [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a056227972d92b22777ee19f60e1794f6) (const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;)=default support copying   
 <a id="ac9b4393e71073c93e662365677ea782b"></a>[IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp; [operator=](class_d_v_s_1_1_i_var_hash.xhtml#ac9b4393e71073c93e662365677ea782b) (const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;)=default default   
 virtual uint32\_t [get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#acc08705e0bdfdea1d42aa358c6167b7d) (uint32\_t index) const =0 Get the size of the hash to use with [IVarHash::get\_var\_hash()](class_d_v_s_1_1_i_var_hash.xhtml#a811a732d5542882667664d079dfdc486 "Get the hash of the variable data.") [More...](class_d_v_s_1_1_i_var_hash.xhtml#acc08705e0bdfdea1d42aa358c6167b7d)  
 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 Get the size of the hash to use with [IVarHash::get\_var\_hash()](class_d_v_s_1_1_i_var_hash.xhtml#a811a732d5542882667664d079dfdc486 "Get the hash of the variable data.") [More...](class_d_v_s_1_1_i_var_hash.xhtml#a81cd99bbf69ccc0d50e8bcb7dd291046)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a811a732d5542882667664d079dfdc486) (uint32\_t index, char \*hash) const =0 Get the hash of the variable data. [More...](class_d_v_s_1_1_i_var_hash.xhtml#a811a732d5542882667664d079dfdc486)  
 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 Get the hash of the variable data. [More...](class_d_v_s_1_1_i_var_hash.xhtml#a7348be86da47ac034252a68949b21007)  
 <a id="details" name="details"></a>## Detailed Description

Mesh Chunk Interface for DVS Reader API.

A mesh chunk in DVS contains the underlying mesh coordinates and nodal variable information for a specific timestep/rank/chunk. It also is the parent object for [IElementBlock](class_d_v_s_1_1_i_element_block.xhtml "Element Block Interface for DVS Reader API.") objects which contain the element / connectivity information. Mesh chucks can be unstructured or structured (paralellepiped or curvilinear). 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 [48](dvs__mesh__chunk__interface_8h_source.xhtml#l00048) of file [dvs\_mesh\_chunk\_interface.h](dvs__mesh__chunk__interface_8h_source.xhtml).



## Member Enumeration Documentation

<a id="a37105a87f7c965d7519eb02f4f63c3d8"></a>## [◆ ](#a37105a87f7c965d7519eb02f4f63c3d8)Axis

 enum [DVS::IMeshChunk::Axis](class_d_v_s_1_1_i_mesh_chunk.xhtml#a37105a87f7c965d7519eb02f4f63c3d8)

The AXIS or IJK component to request.

Enumerator<a id="a37105a87f7c965d7519eb02f4f63c3d8a5f586336dff689b95a213ae63d5d971d"></a>X The X axis (or i component for structured parts)

<a id="a37105a87f7c965d7519eb02f4f63c3d8aa51d837ff28664b76eb076c405cad710"></a>Y The X axis (or j component for structured parts)

<a id="a37105a87f7c965d7519eb02f4f63c3d8a91a3b034071a3ac6c0da72aaac13f1ed"></a>Z The Z axis (or k component for structured parts)

Definition at line [75](dvs__mesh__chunk__interface_8h_source.xhtml#l00075) of file [dvs\_mesh\_chunk\_interface.h](dvs__mesh__chunk__interface_8h_source.xhtml).





<a id="a8b7de1a1e47e05ab63f6bb41ccf5144a"></a>## [◆ ](#a8b7de1a1e47e05ab63f6bb41ccf5144a)MeshType

 enum [DVS::IMeshChunk::MeshType](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144a)

The different mesh types allowed.

Enumerator<a id="a8b7de1a1e47e05ab63f6bb41ccf5144aaa98ab1208c4de624d1af2488ea342b15"></a>UNKNOWN Unknown, a problem occurred.

<a id="a8b7de1a1e47e05ab63f6bb41ccf5144aabd8a1a2f952443e439d96cbea674208e"></a>UNSTRUCTURED Unstructured mesh data.

<a id="a8b7de1a1e47e05ab63f6bb41ccf5144aa95416cf06dfb48f6331a1f7c5c2704d2"></a>PARALLELEPIPED Parallelepiped structured mesh data.

<a id="a8b7de1a1e47e05ab63f6bb41ccf5144aab7e091dc6959aa447a0b6a44be352013"></a>CURVILINEAR Curvilinear structured mesh data.

Definition at line [63](dvs__mesh__chunk__interface_8h_source.xhtml#l00063) of file [dvs\_mesh\_chunk\_interface.h](dvs__mesh__chunk__interface_8h_source.xhtml).





## Member Function Documentation

<a id="a6b894c57bfd1e70168290ce69ecc5af4"></a>## [◆ ](#a6b894c57bfd1e70168290ce69ecc5af4)get\_chunk()

 virtual uint32\_t DVS::IMeshChunk::get\_chunk  ( )  const  pure virtual 

Get the chunk for this mesh chunk.

Returnsuint32\_t the chunk this mesh chunk is associated with (zero based) 



<a id="a7738e954570e849462ff493ec875bc80"></a>## [◆ ](#a7738e954570e849462ff493ec875bc80)get\_coords()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords  ( float \*  *x\_coords*,    float \*  *y\_coords*,    float \*  *z\_coords*   )   pure virtual 

Get the coordinates for an unstructured mesh.

Retrieves the coordinates for an unstructured mesh. To get the coordinates interleaved in a single array call [get\_coords\_interleaved()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a39c2d8cc95f14ecbe9789908881c92a0 "Get the coords for a unstructured meshes interleaved in a single array.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_PARAM\_NULL: nullptr passed into method, method did nothing
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::UNSTRUCTURED
- 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
- DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data.

Parameters \[out\]x\_coordsoutput array for x coordinates (must not be nullptr) size to allocate from [get\_coords\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53 "Get the size of each coordinate component for unstructured meshes.") \[out\]y\_coordsoutput array for y coordinates (must not be nullptr) size to allocate from [get\_coords\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53 "Get the size of each coordinate component for unstructured meshes.") \[out\]z\_coordsoutput array for z coordiantes (must not be nullptr) size to allocate from [get\_coords\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53 "Get the size of each coordinate component for unstructured meshes.") Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors 



<a id="a8da90ca355541bf876fa23ed267f94cb"></a>## [◆ ](#a8da90ca355541bf876fa23ed267f94cb)get\_coords\_curv()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_curv  ( float  *local\_ijk\_min*\[3\],    float  *local\_ijk\_max*\[3\],    float  *global\_ijk\_max*\[3\],    float \*  *x\_coords*,    float \*  *y\_coords*,    float \*  *z\_coords*   )   pure virtual 

Get coordinate data for a structured curvilinear mesh.

Structured curvilinear meshes have the XYZ information for every node in the IJK array for flexibility in defining the nodes. The connectivity for the mesh is implied so there are no connectivity arrays in the DVS::IElemBlock. If you'd like the XYZ coordinates interleaved in a single array call [get\_coords\_curv\_interleaved()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5c191e3ec6d65a527fc1f3224f84d503 "Get the coords for structured curvilinear meshes interleaved in a single array.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_PARAM\_NULL: nullptr passed into method, method did nothing
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::CURVILINEAR
- 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
- DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data.
- DVS\_INVALID\_STRUCTURED\_DATA: Invalid structured data. There is a problem with the data.

Parameters \[out\]local\_ijk\_minarray of size 3, returns 0 based ijk min for this chunk \[out\]local\_ijk\_maxarray of size 3, returns 0 based ijk max for this chunk \[out\]global\_ijk\_maxarray of size 3, returns 1 based global ijk max, this is the total ijk dimension across all mesh chunks \[out\]x\_coordsoutput array for x coordinates (must not be nullptr) size to allocate from [get\_coords\_curv\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a70b1069fc8737730efa0fc01a0698fbd "Get the size of each coordinate component for structured curvilinear meshes.") \[out\]y\_coordsoutput array for y coordinates (must not be nullptr) size to allocate from [get\_coords\_curv\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a70b1069fc8737730efa0fc01a0698fbd "Get the size of each coordinate component for structured curvilinear meshes.") \[out\]z\_coordsoutput array for z coordinates (must not be nullptr) size to allocate from [get\_coords\_curv\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a70b1069fc8737730efa0fc01a0698fbd "Get the size of each coordinate component for structured curvilinear meshes.") Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors 



<a id="a5c191e3ec6d65a527fc1f3224f84d503"></a>## [◆ ](#a5c191e3ec6d65a527fc1f3224f84d503)get\_coords\_curv\_interleaved()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_curv\_interleaved  ( float  *local\_ijk\_min*\[3\],    float  *local\_ijk\_max*\[3\],    float  *global\_ijk\_max*\[3\],    float \*  *coords*   )   pure virtual 

Get the coords for structured curvilinear meshes interleaved in a single array.

Structured curvilinear meshes have the XYZ information for every node in the IJK array for flexibility in defining the nodes. The connectivity for the mesh is implied so there are no connectivity arrays in the DVS::IElemBlock. This method returns the XYZ coordinates interleaved in a single array of the format \[X0 Y0 Z0 X1 Y1 Z1\]. If you'd like the XYZ coordinates in separate x,y,z arrays call [get\_coords\_curv()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8da90ca355541bf876fa23ed267f94cb "Get coordinate data for a structured curvilinear mesh.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_PARAM\_NULL: nullptr passed into method, method did nothing
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::CURVILINEAR
- 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
- DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data.
- DVS\_INVALID\_STRUCTURED\_DATA: Invalid structured data. There is a problem with the data.

Parameters \[out\]local\_ijk\_minarray of size 3, returns 0 based ijk min for this chunk \[out\]local\_ijk\_maxarray of size 3, returns 0 based ijk max for this chunk \[out\]global\_ijk\_maxarray of size 3, returns 1 based global ijk max, this is the total ijk dimension across all mesh chunks \[out\]coordsoutput array of interleaved coords for form \[X0 Y0 Z0 X1 Y0 Z0\] size to allocate component\_size\*3 from [get\_coords\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53 "Get the size of each coordinate component for unstructured meshes.") Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors 



<a id="a70b1069fc8737730efa0fc01a0698fbd"></a>## [◆ ](#a70b1069fc8737730efa0fc01a0698fbd)get\_coords\_curv\_size()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_curv\_size  ( uint32\_t &amp;  *component\_size*)   pure virtual 

Get the size of each coordinate component for structured curvilinear meshes.

Returns the size of each component of a curvilinear mesh. This is used with the method [get\_coords\_curv()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8da90ca355541bf876fa23ed267f94cb "Get coordinate data for a structured curvilinear mesh."). For [get\_coords\_curv\_interleaved()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5c191e3ec6d65a527fc1f3224f84d503 "Get the coords for structured curvilinear meshes interleaved in a single array.") use the size component\_size\*3 to allocate the array.

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::CURVILINEAR
- DVS\_INVALID\_STRUCTURED\_DATA: Structured data is invalid, should not happen

Parameters \[out\]component\_sizethe size of each x/y/z coordinate components Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors 



<a id="a39c2d8cc95f14ecbe9789908881c92a0"></a>## [◆ ](#a39c2d8cc95f14ecbe9789908881c92a0)get\_coords\_interleaved()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_interleaved  ( float \*  *coords*)   pure virtual 

Get the coords for a unstructured meshes interleaved in a single array.

Retrieves the coordinates for an unstructured mesh interleaved (\[X0 Y0 Z0 X1 Y1 Z1\]) instead of as separate X Y Z arrays as the method [get\_coords()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7738e954570e849462ff493ec875bc80 "Get the coordinates for an unstructured mesh.") returns. The coords array should be of size component\_size\*3 returned from [get\_coords\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53 "Get the size of each coordinate component for unstructured meshes.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_PARAM\_NULL: nullptr passed into method, method did nothing
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::UNSTRUCTURED
- 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
- DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data. Parameters \[out\]coordsoutput array of interleaved coords for form \[X0 Y0 Z0 X1 Y0 Z0\] size to allocate component\_size\*3 from [get\_coords\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a0fe402e619754256a19e0087b76e2c53 "Get the size of each coordinate component for unstructured meshes.") Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors





<a id="a959ecd945a3e46b25b4e816a35eb4123"></a>## [◆ ](#a959ecd945a3e46b25b4e816a35eb4123)get\_coords\_parallele()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_parallele  ( float  *origin*\[3\],    float  *dir\_vec\_i*\[3\],    float  *dir\_vec\_j*\[3\],    float  *dir\_vec\_k*\[3\],    float  *local\_ijk\_min*\[3\],    float  *local\_ijk\_max*\[3\],    float  *global\_ijk\_max*\[3\],    float \*  *i\_vals*,    float \*  *j\_vals*,    float \*  *k\_vals*   )   pure virtual 

Get the ijk mesh information for structured parallelepiped mesh chunks.

Retrieves the mesh information for a structured parallelepiped mush chunk. Parallelepiped structured meshes are described by an origin, XYZ direction vectors for each dimension and the amount of distance between the origin at each I, K and K increment. To get the size to allocate for i\_vals, j\_vals, and k\_vals call [get\_coords\_parallele\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#abda21734e2f506b982b65007d17c92fd "Get the size of each ijk component for structured parallelpiped meshes.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_PARAM\_NULL: nullptr passed into method, method did nothing
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::CURVILINEAR
- 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
- DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data.
- DVS\_INVALID\_STRUCTURED\_DATA: Invalid structured data. There is a problem with the data.

Parameters \[out\]originThe XYZ origin of the mesh \[out\]dir\_vec\_iarray of size 3, returns the XYZ direction vector for I dimension \[out\]dir\_vec\_jarray of size 3, returns the XYZ direction vector for J dimension \[out\]dir\_vec\_karray of size 3, returns the XYZ direction vector for K dimension \[out\]local\_ijk\_minarray of size 3, returns 0 based ijk min for this chunk \[out\]local\_ijk\_maxarray of size 3, returns 0 based ijk max for this chunk \[out\]global\_ijk\_maxarray of size 3, returns 1 based global ijk max, this is the total ijk dimension across all mesh chunks \[out\]i\_valsthe distance at each I increment from the origin size to allocate from [get\_coords\_parallele\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#abda21734e2f506b982b65007d17c92fd "Get the size of each ijk component for structured parallelpiped meshes.") \[out\]j\_valsthe distance at each J increment from the origin size to allocate from [get\_coords\_parallele\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#abda21734e2f506b982b65007d17c92fd "Get the size of each ijk component for structured parallelpiped meshes.") \[out\]k\_valsthe distance at each K increment from the origin size to allocate from [get\_coords\_parallele\_size()](class_d_v_s_1_1_i_mesh_chunk.xhtml#abda21734e2f506b982b65007d17c92fd "Get the size of each ijk component for structured parallelpiped meshes.") Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors 



<a id="abda21734e2f506b982b65007d17c92fd"></a>## [◆ ](#abda21734e2f506b982b65007d17c92fd)get\_coords\_parallele\_size()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_parallele\_size  ( uint32\_t &amp;  *i\_vals\_size*,    uint32\_t &amp;  *j\_vals\_size*,    uint32\_t &amp;  *k\_vals\_size*   )   pure virtual 

Get the size of each ijk component for structured parallelpiped meshes.

Returns the size of each component of a parallelpiped mesh. This is used with the method [get\_coords\_parallele()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123 "Get the ijk mesh information for structured parallelepiped mesh chunks."). Use the sizes returned to allocate the arrays for [get\_coords\_parallele()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123 "Get the ijk mesh information for structured parallelepiped mesh chunks.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::CURVILINEAR
- DVS\_INVALID\_STRUCTURED\_DATA: Structured data is invalid, There is a problem with the data.

Parameters i\_vals\_sizesize of the i dimension array to allocate for [get\_coords\_parallele()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123 "Get the ijk mesh information for structured parallelepiped mesh chunks.") j\_vals\_sizesize of the j dimension array to allocate for [get\_coords\_parallele()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123 "Get the ijk mesh information for structured parallelepiped mesh chunks.") k\_vals\_sizesize of the k dimension array to allocate for [get\_coords\_parallele()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a959ecd945a3e46b25b4e816a35eb4123 "Get the ijk mesh information for structured parallelepiped mesh chunks.") Returnsdvs\_ret DVS\_NONE on success, see method documentation for errors 



<a id="a0fe402e619754256a19e0087b76e2c53"></a>## [◆ ](#a0fe402e619754256a19e0087b76e2c53)get\_coords\_size()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_coords\_size  ( uint32\_t &amp;  *component\_size*)   pure virtual 

Get the size of each coordinate component for unstructured meshes.

Used for unstructured meshes. Returns the size of each x/y/z coordinate array to be used with [get\_coords()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7738e954570e849462ff493ec875bc80 "Get the coordinates for an unstructured mesh.") or component\_size\*3 for [get\_coords\_interleaved()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a39c2d8cc95f14ecbe9789908881c92a0 "Get the coords for a unstructured meshes interleaved in a single array.").

Errors:

- DVS\_NO\_DATA: No data for this mesh, not an error
- DVS\_INVALID\_MESH\_TYPE: Mesh type is not DVS::IMeshChunk::MeshType::UNSTRUCTURED

Parameters \[out\]component\_sizethe size of each x/y/z coordinate components Returnsdvs\_ret DVS\_NONE on no error, see method documentation for errors 



<a id="a5d8b6af69d5c31c0017be9c8f6c3b28f"></a>## [◆ ](#a5d8b6af69d5c31c0017be9c8f6c3b28f)get\_element\_block()

 virtual [DVS::IElementBlock](class_d_v_s_1_1_i_element_block.xhtml)\* DVS::IMeshChunk::get\_element\_block  ( uint32\_t  *index*)   pure virtual 

Get the element block by index.

Get the element block according to it's index in the mesh chunk. This range is from \[0, [get\_num\_element\_blocks()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5f3772e845d3ffe73c4a6525d78ab2ad "Get the number of element blocks for this mesh chunk.")-1\]. Every mesh chunk has a number of element blocks for each element type it has data for.

Parameters \[in\]indexthe zero based index of the element block range: \[0, [get\_num\_element\_blocks()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5f3772e845d3ffe73c4a6525d78ab2ad "Get the number of element blocks for this mesh chunk.")-1\] Returns[DVS::IElementBlock](class_d_v_s_1_1_i_element_block.xhtml "Element Block Interface for DVS Reader API.")\* nullptr if index is out of bounds, otherwise the element block 



<a id="a54b8d01348ef368966b49c1329e74b74"></a>## [◆ ](#a54b8d01348ef368966b49c1329e74b74)get\_element\_block\_by\_type()

 virtual [DVS::IElementBlock](class_d_v_s_1_1_i_element_block.xhtml)\* DVS::IMeshChunk::get\_element\_block\_by\_type  ( [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895)  *type*)   pure virtual 

Get the element block by element type.

Get the element block by dvs\_element\_type from this mesh chunk, the valid types for this mesh chunk may be obtained via the method [get\_element\_block\_types()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a44a916bcd71f4d6b33661b249d52c61b "Get an array of the element block types for this mesh chunk.").

Every mesh chunk has an element block for each element type it has data available for. These types are defined by the enum dvs\_element\_type in [dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml "Contains enums used in C/C++ API.") with a macro FOREACH\_ELEM\_ENUM.

Parameters \[in\]typethe type of element block to retrieve Returns[DVS::IElementBlock](class_d_v_s_1_1_i_element_block.xhtml "Element Block Interface for DVS Reader API.")\* nullptr if invalid, otherwise the element block 



<a id="a44a916bcd71f4d6b33661b249d52c61b"></a>## [◆ ](#a44a916bcd71f4d6b33661b249d52c61b)get\_element\_block\_types()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_element\_block\_types  ( [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) \*  *element\_types*)  const  pure virtual 

Get an array of the element block types for this mesh chunk.

This returns an array of dvs\_element\_type for every block this mesh chunk contains. These types are defined by the enum dvs\_element\_type in [dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml "Contains enums used in C/C++ API.") with a macro FOREACH\_ELEM\_ENUM.

Parameters \[out\]element\_typesan array of size [get\_num\_element\_blocks()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a5f3772e845d3ffe73c4a6525d78ab2ad "Get the number of element blocks for this mesh chunk.") to fill out Returnsdvs\_ret DVS\_NONE on no errors, DVS\_PARAM\_NULL if element types nullptr 



<a id="a5f3772e845d3ffe73c4a6525d78ab2ad"></a>## [◆ ](#a5f3772e845d3ffe73c4a6525d78ab2ad)get\_num\_element\_blocks()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_num\_element\_blocks  ( uint32\_t &amp;  *num\_elem\_blocks*)  const  pure virtual 

Get the number of element blocks for this mesh chunk.

Every mesh chunk has an element block for each element type it has data available for. These types are defined by the enum dvs\_element\_type in [dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml "Contains enums used in C/C++ API.") with a macro FOREACH\_ELEM\_ENUM.

Errors:

- DVS\_NONE: Success

Parameters \[out\]num\_elem\_blocksif success, returns number of element blocks for this mesh chunk ReturnsDVS\_NONE on success, else see method description 



<a id="a7ec07c07cdc908ec42b40e3c42c0a5f4"></a>## [◆ ](#a7ec07c07cdc908ec42b40e3c42c0a5f4)get\_num\_variables()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_num\_variables  ( uint32\_t &amp;  *num\_vars*)  const  pure virtual 

Get the number of nodal variables this mesh chunk has data for.

This method is intended to be used in conjunction with [get\_variable()](class_d_v_s_1_1_i_mesh_chunk.xhtml#afd77fb928baa23c8c453f897e082f880 "Get the variable definition associates with the nodal variable for this index.") and [get\_variable\_data()](class_d_v_s_1_1_i_mesh_chunk.xhtml#ab72dfdd09b4258da7de7308ef48cb1fc "Get the variable data by index.") to retrieve nodal variable data.

Errors:

- DVS\_NONE: Success

Parameters num\_varsif success, returns the number of nodal variables for this mesh chunk Returnsdvs\_ret DVS\_NONE if success, else see method description 



<a id="ae4ff384a5739e480c88097bef524d4bd"></a>## [◆ ](#ae4ff384a5739e480c88097bef524d4bd)get\_object()

 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml)\* DVS::IMeshChunk::get\_object  ( )  const  pure virtual 

Get the object definiton this mesh chunk is associated with.

Returnsconst [DVS::IObject](class_d_v_s_1_1_i_object.xhtml "Interface for part/plot objects for DVS Reader API.")\* the object definition 



<a id="a6c520674083999e99bdf77b2b1eaacf8"></a>## [◆ ](#a6c520674083999e99bdf77b2b1eaacf8)get\_rank()

 virtual uint32\_t DVS::IMeshChunk::get\_rank  ( )  const  pure virtual 

Get the rank for the mesh chunk.

Returnsuint32\_t the rank this mesh chunk is associated with (zero based) 



<a id="a32ad562394805327fbabffa322643701"></a>## [◆ ](#a32ad562394805327fbabffa322643701)get\_time()

 virtual float DVS::IMeshChunk::get\_time  ( )  const  pure virtual 

Get the time for this mesh chunk.

Returnsfloat the time this mesh chunk is associated with 



<a id="ab025d1550b2b3cd77faefecec5199852"></a>## [◆ ](#ab025d1550b2b3cd77faefecec5199852)get\_type()

 virtual [MeshType](class_d_v_s_1_1_i_mesh_chunk.xhtml#a8b7de1a1e47e05ab63f6bb41ccf5144a) DVS::IMeshChunk::get\_type  ( )  const  pure virtual 

Get the type of mesh chunk.

ReturnsMeshType the type of mesh 



<a id="afd77fb928baa23c8c453f897e082f880"></a>## [◆ ](#afd77fb928baa23c8c453f897e082f880)get\_variable()

 virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml)\* DVS::IMeshChunk::get\_variable  ( uint32\_t  *index*)  const  pure virtual 

Get the variable definition associates with the nodal variable for this index.

This method retrieves the variable that is associated with the nodal variable of the mesh chunk at a specific index in range \[0,[get\_num\_variables()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4 "Get the number of nodal variables this mesh chunk has data for.")-1\]

Parameters \[in\]indexindex of variable definition to get in range \[0, [get\_num\_variables()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4 "Get the number of nodal variables this mesh chunk has data for.")-1\] 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 



<a id="ada793fcafd36d800dc3c4249b193318c"></a>## [◆ ](#ada793fcafd36d800dc3c4249b193318c)get\_variable\_data() \[1/2\]

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::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 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\]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 



<a id="ab72dfdd09b4258da7de7308ef48cb1fc"></a>## [◆ ](#ab72dfdd09b4258da7de7308ef48cb1fc)get\_variable\_data() \[2/2\]

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IMeshChunk::get\_variable\_data  ( uint32\_t  *index*,    uint32\_t \*  *num\_values*,    float \*  *array*   )   pure virtual 

Get the variable data by index.

This method retrieves nodal variable data based on an index in range \[0,[get\_num\_variables()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4 "Get the number of nodal variables this mesh chunk has data for.")-1\]. To retrieve the variable definition associated with the index call [get\_variable()](class_d_v_s_1_1_i_mesh_chunk.xhtml#afd77fb928baa23c8c453f897e082f880 "Get the variable definition associates with the nodal 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()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4 "Get the number of nodal variables this mesh chunk 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()](class_d_v_s_1_1_i_mesh_chunk.xhtml#a7ec07c07cdc908ec42b40e3c42c0a5f4 "Get the number of nodal variables this mesh chunk 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 



---

The documentation for this class was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/user\_defined\_src/readers/dvs/include/[dvs\_mesh\_chunk\_interface.h](dvs__mesh__chunk__interface_8h_source.xhtml)