DVS::IElementBlock Class Reference

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().

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]

indices

If not nullptr should be of size indices_size from get_connectivity_size()

Returns

dvs_ret DVS_NONE on no error, see the method documentation for errors

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().

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_polygon	an ouput array of size nodes_per_polygon_size from get_connectivity_polygon_size()
[out]	indices	an output array of size indices_size from get_connectivity_polygon_size()

Returns

dvs_ret DVS_NONE on no error, see the method documentation for errors

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().

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_size	the number of nodes per polygon, this is also the total number of elements
[out]	indices_size	the total size of the connectivity array

Returns

dvs_ret DVS_NONE on no error, see the method documentation for errors

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().

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_element	and output array of size faces_per_element_size from get_connectivity_polyhedral_size()
[out]	nodes_per_face	an output array of size nodes_per_face_size from get_connectivity_polyhedral_size()
[out]	indices	an output array of size indices_size from get_connectivity_polyhedral_size()

Returns

dvs_ret DVS_NONE on no error, see the method documentation for errors

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().

Error Codes:

• DVS_NONE: No error
• DVS_INVALID_ELEMENT_TYPE: This element block is not a basic unstructured type

Parameters

[out]	faces_per_element_size	the number of faces per element, this is also the total number of elements
[out]	nodes_per_face_size	the number of nodes for each face in an element
[out]	indices_size	the total number of indices in the connectivity array

Returns

dvs_ret DVS_NONE on no error, see the method documentation for errors

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()

Error Codes:

• DVS_NONE: No error
• DVS_INVALID_ELEMENT_TYPE: This element block is not a basic unstructured type

Parameters

[out]

indices_size

the size of the connectivity array for this element block

Returns

dvs_ret DVS_NONE on no error, see the method documentation for errors

Get the element type for this block.

Returns

dvs_element_type the element type for this block

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)

Returns

true if unstructured ghost elements

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_element

the number of nodes per element

Returns

dvs_ret DVS_NONE on no error, otherwise see method documentation

Get the number of elements for this block.

Parameters

[out]

num_elements

the number of elements for this block

Returns

dvs_ret DVS_NONE on no error

Get the number of elemental variables this element block has data for.

This method is intended to be used in conjunction with get_variable() and get_variable_data() to retrieve elemental variable data.

Errors:

• DVS_NONE: Success

Parameters

[out]

num_vars

if success, returns the number of variables on this element block

Returns

DVS_NONE on success, else see method description

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()-1]

Parameters

[in]

index

index of variable definition to get in range [0, get_num_variables()-1]

Returns

DVS::IVar* nullptr if out of range, otherwise the variable associated with the index

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]	var	the variable definition to retrieve elemental variable data for
[out]	num_values	if not nullptr returns the number of values to allocate for array
[out]	array	if not nullptr should be of size num_values

Returns

dvs_ret DVS_NONE on no error, otherwise see method description

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()-1]. To retrieve the variable definition associated with the index call get_variable().

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()-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]	index	index of the variable data in range [0,get_num_variables()-1]
[out]	num_values	if not nullptr returns the number of values to allocate for array
[out]	array	if not nullptr must be of size num_values

Returns

dvs_ret DVS_NONE on no error, otherwise see method description