HM_ExtAPI::ElementGetGrid()

Returns grid points that define an element.

Syntax

bool ElementGetGrid(
const HM_EntityMesh & hmesh,
const HM_EntityElement & helem,
int  gind,
HM_EntityGrid & hgrid
);

Type

HyperMesh Ext API

Description

The element referenced by the handle helem must belong to the mesh referenced by the handle hmesh. That is only the element handles obtained in previous calls to API functions using the same mesh handle hmesh must be used.

The index that references the grid point of the element should be within the range from zero and number of element grid points minus one.

The number of grid points and the order of grid points for the element are predefined by the element type returned in a call to the function HM_ExtAPI::ElementGetType().

If the function succeeds, the return value is true. If the function fails, the return value is false. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Requires including hm_extapi.h.

Inputs

hmesh
[in] - Handle to mesh object that was returned by previous calls to API functions.
helem
[in] - Handle that references the element.
gind
[in] - Grid point zero-based index. This number should be smaller than total number of the grids of the element.
hgrid
[out] - Handle that references the grid.

Errors

None.