Mesh

Overview

The Mesh class provides comprehensive functionality for managing finite element mesh topology, geometry, and connectivity. It supports both structured and unstructured grids with capabilities for defining nodes, elements, element topology, associations, and adjacency queries.

The Mesh module is designed to manage finite element connectivities and generate information which is dependent upon the adjacency properties of the finite element mesh. For example, the Mesh module can provide sets of the external faces and unique edges of any element subset. Element adjacencies may be be queried across element faces, edges or nodes.

Element adjacency properties are not immediately accessible from standard finite element node connectivity lists. The Mesh module generates and maintains a data structure, termed the connection “kernel”, which is approximately the same size as the element node connectivity list. This single data structure provides efficient query of all the above mentioned adjacency related data. The Mesh object can manage the adjacency kernel information in one of two ways, 1) statically, optimized for unchanging element connections such as in post-processing (STATIC) and 2) dynamically, optimized for a frequently changing element connections such as can occur in pre-processing (DYNAMIC).

The Mesh module may optionally allocate and manage the basic element node connectivities or access this information from host application data structures via a MeshInterface object. This feature gives the software designer the option of retaining element node connectivity data structures within the host application or yielding the management of this data to a Mesh object. The functions associated with a Mesh object are the following.

Error handling
- getErrorCode() - Get current error code
Mesh definition and configuration
- setPrecision() - Set precision of node coordinates
- getPrecision() - Get current precision
- define() - Define number of nodes and elements
- inquire() - Inquire number of nodes and elements
- setOperatingMode() - Set STATIC or DYNAMIC
- setDimension() - Set spatial dimension
- getDimension() - Determine spatial dimension
External object management
- setState() - Set State object for node coordinates
- getState() - Get State object
- setMeshInterface() - Set MeshInterface object
- getMeshInterface() - Get MeshInterface object
Parameters
- setFloatParameter() - Set floating point parameters
- setIntegerParameter() - Set integer parameters
Entity counting
- getEntityCount() - Get number of nodes, elements, faces, or edges
Element topology
- setTopology() - Set element topology
- getTopology() - Get element topology
Element management
- deleteElement() - Delete an element
- isElementDefined() - Query if element is defined
- generateElement() - Generate an element index
- setIntegrationPointCount() - Set number of element integration points
- getIntegrationPointCount() - Get number of element integration points
Element connectivity
- setElementNodes() - Set element node connectivity
- getElementNodes() - Get element node connectivity
- getMaxElementNodes() - Get maximum nodes connected to any element
- getElementNodeCount() - Get number of nodes in an element
Node coordinates
- setCoordinates() - Set node coordinates (float and double overloads)
- getCoordinates() - Get node coordinates (float and double overloads)
Node management
- deleteNode() - Delete a node
- isNodeDefined() - Query if node is defined
- generateNode() - Generate a node index
Index translation
- getNodeIndex() - Get node index from user ID
- getElementIndex() - Get element index from user ID
Part management
- setPartName() - Set part name string
- getPartName() - Get part name string
- getPartNameCount() - Get number of part names
- getPartInformation() - Get specific part name and ID
- setPartIJK() - Set IJK block parameters for part
- getPartIJK() - Get IJK block parameters for part
- getPartIJKCount() - Get number of part IJK blocks
- getPartIJKFromPartIndex() - Get specific part IJK block
Node associations
- setNodeAssociation - Set node association
- getNodeAssociation - Get node associations
- addNodeAssociation - Add additional node association
- deleteNodeAssociation - Delete added node associations
- getNodeAssociationCount - Get number of node associations
- getAllNodeAssociations - Get all node associations
Element associations
- setElementAssociation - Set element association
- getElementAssociation - Get element associations
- addElementAssociation - Add additional element association
- deleteElementAssociation - Delete added element associations
- getElementAssociationCount - Get number of element associations
- getAllElementAssociations - Get all element associations
Element entity associations
- setElementEntityAssociation() - Set element face/edge association
- getElementEntityAssociation() - Get element face/edge association
- addElementEntityAssociation() - Add element face/edge association
- deleteElementEntityAssociation() - Delete element face/edge associations
- getElementEntityAssociationCount() - Get number of element entity associations
- getAllElementEntityAssociations() - Get all element entity associations
Element entity topology and connectivity
- getElementEntityCount() - Get number of element faces, edges, or nodes
- getElementEntityConnectivity() - Get element face/edge node connectivity
- getElementEntityConnectionNumbers() - Get element face/edge connection numbers
- getElementEntityCornerConnectionNumbers() - Get element face/edge corner connections
- getElementEntityTopology() - Get element face/edge topology
Element face normals
- setElementFaceNormals() - Set element face normals (float and double overloads)
- isElementFaceNormalsDefined() - Query if face normals are defined
- getElementFaceNormals() - Get element face normals (float and double overloads)
Element edge tangents
- setElementEdgeTangent() - Set element edge tangents (float and double overloads)
- isElementEdgeTangentDefined() - Query if edge tangents are defined
- getElementEdgeTangent() - Get element edge tangents (float and double overloads)
Kernel generation and management
- generateKernel() - Generate connection kernel
- clearKernel() - Clear connection kernel
- kernelExists() - Check if kernel exists
Element adjacency queries
- getMaxElementCountConnectedToNode() - Get max elements connected to any node
- getElementCountConnectedToNode() - Get number of elements connected to node
- getElementsConnectedToNode() - Get elements connected to node
- getAdjacentElements() - Get elements adjacent to element
- getAdjacentElementsToFace() - Get adjacent elements with face IDs
- getAdjacentElementEntities() - Get adjacent elements with entities
- getAdjacentElementEntitiesUsingCornerNodesOnly() - Get adjacent elements (corner nodes only)
- getElementsAdjacentToNodes() - Get elements adjacent to nodes
Extent operations
- getExtent() - Get coordinate extent (float and double overloads)
- getExtentLocation() - Get extent with node indices
- getExtentLocationInCoordinateSystem() - Get extent in coordinate system
Group derivation parameters
- setGroupFloatParameter() - Set group float parameter
- setGroupFloatParameterArray() - Set group float parameter array
- setGroupIntegerParameter() - Set group integer parameter
- setGroupElementAssociationType() - Set group element association type
- setGroupNodeAssociationType() - Set group node association type
- setSeedGroup() - Set seed group for operations
Group derivation operations
- getElementGroup() - Derive element group
- getFaceGroup() - Derive face group
- getEdgeGroup() - Derive edge group
- getNodeGroup() - Derive node group
- getElementRegion() - Derive element regions
- getNodeRegion() - Derive node regions
Mesh modification operations
- mergeWithNodeMapping() - Merge nodes with mapping
- merge() - Merge coincident nodes
- splitElement() - Split simplex element
- copy() - Copy entire mesh
- append() - Append mesh
- extractSubset() - Extract mesh subset
- extractSubsetWithElementMapping() - Extract subset with element mapping
- tesselate() - Convert higher order to linear elements
Mesh analysis operations
- getElementSize() - Compute element volume/area/length
- getIntersectionPlane() - Compute plane intersections
- checkElementIndex() - Validate element index
Utility operations
- print() - Print detailed mesh information
- printSummary() - Print mesh statistics
- getMeshInterfacePointers() - Get internal function pointers
I/O operations
- read() - Read mesh from file
- write() - Write mesh to file
- runDemo() - Generate demo finite element model
Threading
- setThreadCount() - Set OpenMP thread count

Mesh Initialization and Configuration

Create a Mesh object instance. Once instantiated, the user may specify the precision used to maintain node coordinates using setPrecision(). By default, node coordinates are held in single precision. The number of nodes and elements to be represented by the object is defined using define(). At this stage, only a very small amount of memory has been allocated by the Mesh object for internal pointer and attribute variables. If the exact number of nodes and/or elements is not known, then make initial estimates (0 is allowed) and call define() with these estimates. The Mesh module will adjust memory as required.

The primary data managed by the Mesh object is element topology and connectivity and node coordinates. The Mesh object can obtain access to this data in two ways:

Implement a MeshInterface with element connectivity and node coordinate query functions and set this using setMeshInterface()
Load element topology, connectivity and node coordinates directly into the Mesh object using setTopology(), setElementNodes() and setCoordinates() respectively.

The first option requires that the host application “own” the element connectivity and geometry; the Mesh object allocates no memory for it. All element connectivity information required by the Mesh object is obtained from the host application via the MeshInterface query functions. The second option requires that the host application load element topology, connectivity and node coordinates into the Mesh object. Once Mesh has access to the primary element and node information, the functions getTopology(), getElementNodes() and getCoordinates() which query element connectivity and node coordinate information may be called.

Node and Element Editing and Element Adjacency Query

If the primary element and node information has been loaded directly into the Mesh object (rather than using a MeshInterface), there are two ways to manage the data depending upon the volatility of the data. The internal data structures used are optimized for these two modes. If the primary element and node information is unchanging, as in a post-processing application, this is termed the STATIC mode; if the primary element and node information is volatile, as in a pre-processing application, this is termed the DYNAMIC mode. By default the Mesh object is in the STATIC mode. Use the function setOperatingMode() to change from STATIC to DYNAMIC mode or vice versa. If the primary element and node information is accessed using a MeshInterface, only the STATIC mode is supported.

In the DYNAMIC mode, the Mesh object supports element and node editing using the functions deleteElement(), isElementDefined(), generateElement() and corresponding functions for nodes, deleteNode(), isNodeDefined(), generateNode(). Deleting an element or node marks it as undefined and releases internal memory for use to define other elements or nodes. By default an element is undefined until it is entered using setTopology() or queried using generateElement(). A node is undefined until it is entered explicitly using setCoordinates(), referenced in the element connectivity list of an element using setElementNodes(), or queried using generateNode(). The functions isElementDefined() and isNodeDefined() return a flag indicating whether an element or node has been defined. The functions generateElement() and generateNode() return an available undefined element or node index and in the process change its status to a defined element or node. Elements and nodes may be redefined by calling setTopology() and setCoordinates() respectively.

In addition to the primary element and node information, the Mesh object can derive element adjacency information from the primary element connectivity. Providing element adjacency information requires additional memory and processing effort. The data structure used to provide the adjacency information is termed the “kernel”. In the STATIC mode, the kernel must be generated explicitly using generateKernel(). This function allocates a quantity of memory approximately equal to the number of entries in the element node connection list. This function also is the most compute intensive Mesh method. The algorithm to create the connection kernel has the quality of being linear with respect to the number of elements. In the DYNAMIC mode, the kernel is maintained implicitly as each element or node is generated and/or deleted. The function call to generateKernel() is not required.

Once the kernel is created, adjacency requests may be made. Use getAdjacentElements() to return a list of elements adjacent to a given element through a face, edge or node. Use getAdjacentElementEntities() to return a list of elements and their associated edges or faces adjacent to a given element through a face, edge or node. Use getElementsAdjacentToNodes() to return a list of elements adjacent to a given set of nodes. Sets of element edges and faces with important properties (external faces, free edges or unique edges) may be returned for any element subset encoded in a Group object using getEdgeGroup() and getFaceGroup() respectively.

Node and Element Associations

Nodes, elements, and element edges and faces may be assigned integer values called “associations”. Associations provide metadata and identifiers for mesh entities. The C++ API defines separate enumeration types for node and element associations to provide type safety and clarity. These enumerations are defined as follows: NodeAssociationType and ElementAssociationType.

Common Association Types

Some association types are available for both nodes and elements:

PART_ID - Part identifier
COORDINATE_SYSTEM_ID - Solution coordinate system identifier
IBLANK - Iblank code
USER_ID - User defined identifier
MISCELLANEOUS_ID0 through MISCELLANEOUS_ID8 - Generic miscellaneous identifiers

The miscellaneous identifiers (MISCELLANEOUS_ID0 through MISCELLANEOUS_ID8) are provided for generic use and can store application-specific metadata.

Working with Associations

A single association of a particular type can be assigned to a node or element. This single association is set at nodes and elements using setNodeAssociation and setElementAssociation respectively. It may be queried using getNodeAssociation and getElementAssociation. If a particular association has not been set, its value will be returned as 0 when queried.

Element Entity Associations

Associations may be set for individual element edges and faces. This type of association is termed an element entity association. Element entity associations are set using setElementEntityAssociation() and queried using getElementEntityAssociation(). Element edge and face associations are most often used to associate these features with underlying geometry edge and face identifiers (using GEOMETRY_EDGE_ID and GEOMETRY_FACE_ID).

Multiple Associations

It is possible to specify multiple associations of a particular type at a single entity. Multiple node associations are managed using addNodeAssociation, deleteNodeAssociation, getNodeAssociationCount and getAllNodeAssociations. Similarly, multiple element associations are managed using addElementAssociation, deleteElementAssociation, getElementAssociationCount and getAllElementAssociations.

The function addNodeAssociation will specify associations at a node in addition to the single association (which may have a value of 0) always present at a node. Any additional node associations may be deleted using deleteNodeAssociation. This function only affects node associations added using addNodeAssociation. The total number of associations of a type specified at a node may be queried using getNodeAssociationCount. The number returned is 1 plus the number of associations added using addNodeAssociation. All associations defined at a node may be queried using getAllNodeAssociations, which returns the single association set using setNodeAssociation and all additional associations specified using addNodeAssociation.

Part Names and IJK Structure

The PART_ID association is designed to be used with the naming capability of the Mesh object. The function setPartName() can be used to associate a character string with each PART_ID value. Use getPartName() to retrieve the name character string given the PART_ID value.

It is also possible to specify the block IJK structure of a part. Use the function setPartIJK() to associate a block IJK structure with each PART_ID value. Use getPartIJK() to retrieve the IJK block structure given the PART_ID value. If a part has a block IJK structure, the nodes and elements of the block will be sequentially ordered in the I direction first, followed by the J and K directions respectively.

Deriving Element, Face, Edge and Node Groups

The Mesh class provides four functions to generate Group objects containing elements, element faces, element edges, and nodes. These group derivation functions are:

getElementGroup() - Derive element groups
getFaceGroup() - Derive face groups
getEdgeGroup() - Derive edge groups
getNodeGroup() - Derive node groups

Examples of generated groups include: element groups of intersecting elements, element face groups of external faces, element edge groups of feature edges, and node groups of nodes connected to the corner nodes of higher order elements. Each function accepts an optional input seed Group (set via setSeedGroup()) to limit the operation to the entities in the seed group.

Group Derivation Parameters

Before calling group derivation functions, various parameters can be configured:

setGroupFloatParameter() - Set floating-point parameters for group operations
setGroupFloatParameterArray() - Set floating-point parameter arrays
setGroupIntegerParameter() - Set integer parameters for group operations
setGroupElementAssociationType() - Specify element association type for partitioning
setGroupNodeAssociationType() - Specify node association type for partitioning

Face Groups for Display

A particularly useful operation prepares sets of element faces for graphical display purposes. These operations use a specified element association type to partition the full set of elements.

Use getFaceGroup() with appropriate parameters to generate element faces which lie on elements with an adjacent element across the face having a differing association value. This is typically used with association types MATERIAL_ID, PROPERTY_ID, or PART_ID to generate the faces which bound elements in each material, property, or part region. By default, free faces of each region are not included in the generated Group. The inclusion of free faces can be controlled using setGroupIntegerParameter().

Edge Groups for Display

Use getEdgeGroup() with an input element face group (generated as described above) to generate the unique edges or feature edges of the element faces in the source group. These groups are useful for graphical display of element mesh edges or element mesh feature edges of bounding element faces. Using getEdgeGroup() with an element source group can generate all the unique edges of sets of elements which share an edge association value. This group is useful for graphical display of all mesh edges of each material, property, or part region.

Element Face Normals and Edge Tangents

The Mesh class contains functions to refine the geometry of elements by specifying optional element face normals and element edge tangents.

setElementFaceNormals() - Set element face normals (float and double overloads)
getElementFaceNormals() - Get element face normals (float and double overloads)
isElementFaceNormalsDefined() - Query if face normals are defined
setElementEdgeTangent() - Set element edge tangents (float and double overloads)
getElementEdgeTangent() - Get element edge tangents (float and double overloads)
isElementEdgeTangentDefined() - Query if edge tangents are defined

If the face normals or edge tangents have not been set using setElementFaceNormals() or setElementEdgeTangent(), then the normals and tangents are computed automatically using the element node coordinate geometry. Use isElementFaceNormalsDefined() and isElementEdgeTangentDefined() to query whether face normals or edge tangents have been explicitly set.

Geometric Tessellation

The tesselate() function can be used to tessellate higher-order elements, converting them into linear elements. This operation is useful for visualization and analysis purposes where linear elements are preferred or required.

The tessellation process can be controlled using mesh parameters set via setFloatParameter() and setIntegerParameter(). Parameters such as tolerance values and subdivision sizes can influence the tessellation behavior.

When elements are tessellated, the resulting linear elements inherit all element associations from the original higher-order elements, preserving material, property, and part identifiers.

Using MeshInterface for External Data

A Mesh object can use a MeshInterface object to optionally access finite element data from the host application without duplicating the data in memory.

The MeshInterface should implement callback functions to provide:

Node coordinates (single and double precision)
Element node connectivity
Element topology information
Node and element associations
Maximum element node counts
Entity numbering/indexing

Set the MeshInterface using setMeshInterface(). The mesh object will then query data through the interface rather than maintaining its own internal copies.

Class Members Descriptions

The currently available Mesh enumerations and functions are described in detail in this section.

class Mesh

Mesh class for creating and managing mesh connectivity, properties and mesh operations.

Public Types

enum class IntegerParameter

Integer properties for mesh configuration.

Values:

enumerator REDEFINE_TOPOLOGY: Redefine mesh topology after initial definition.

enumerator EXACT_ADJACENCY: Use exact adjacency for element connectivity.

enumerator LAYER_ASSOCIATION: Enable layer association for mesh entities.

enumerator ZERO_USER_ID: Use zero-based user IDs for mesh entities.

enum class FloatParameter

Floating point properties for mesh configuration.

Values:

enumerator TOLERANCE: Tolerance for geometric operations.

enumerator SIZE: Arc length or size parameter for mesh entities.

enum class Mode

Operating mode for the mesh.

Values:

enumerator STATIC: Static mode (no dynamic updates).

enumerator DYNAMIC: Dynamic mode (supports updates).

enum class RegionOperation

Operations for extracting mesh regions.

Values:

enumerator UNCONNECTED_REGIONS: Extract unconnected regions (free bodies).

enumerator TOPOLOGICALLY_SIMILAR_BODIES: Extract topologically similar bodies.

enumerator NODAL_AVERAGING_REGIONS: Extract regions for nodal averaging.

enumerator USER_ID: Extract regions by user-defined ID.

enum class GroupOperation

Operations for creating or querying mesh groups.

Values:

enumerator FIRST_ENTITY_OCCURRENCE: Select first occurrence of each entity.

enumerator FREE_ENTITIES: Select entities not connected to others.

enumerator CONNECTED_ENTITIES: Select entities connected to elements.

enumerator FEATURE: Select feature entities (e.g., sharp edges).

enumerator ASSOCIATION: Select entities by association value.

enumerator ELEMENTS_OF_SHAPE: Select elements of a given shape.

enumerator ELEMENTS_OF_DIMENSION: Select elements of a given dimension.

enumerator WITHIN_EXTENT: Select entities within a spatial extent.

enumerator ENTITIES_WITH_ALL_NODES_IN_GROUP: Entities with all nodes in a group.

enumerator ENTITIES_USED_BY_N_ELEMENTS: Entities used by N elements.

enumerator CONNECTED_TO_N_NODES: Entities connected to N nodes.

enumerator INCONSISTENT_2D_ELEMENTS: 2D elements with inconsistent orientation.

enumerator CURVATURE_DISCONTINUITY: Entities at curvature discontinuity.

enumerator ENTITIES_PROPAGATING_FROM_SEED: Entities reached by flood fill from a seed.

enumerator NONMANIFOLD: Nonmanifold entities.

enumerator CORNER_NODES: Corner nodes in the mesh.

enumerator ENTITIES_WITH_ANY_ASSOCIATION_VALUE: Entities with any association value.

enumerator DIFFERING_ASSOCIATION: Entities with differing association values.

enumerator ELEMENTS_WITH_EDGE_FACE_INTERSECTIONS: Elements with edge/face intersections.

enumerator FIRST_ENTITY_OCCURRENCE_PER_FACE_ASSOCIATION: First entity per face association.

enumerator FEATURE_ENTITY_PER_ASSOCIATION: Feature entity per association.

enumerator FIRST_ENTITY_OCCURRENCE_PER_ENTITY_ASSOCIATION: First entity per entity association.

enumerator FEATURE_BOUND_FLOOD_FILL_ENTITIES: Entities from feature-bound flood fill.

enum class GroupIntegerParameter

Integer parameters for mesh groups.

Values:

enumerator ASSOCIATION_ID: Association ID for group selection.

enumerator USE_NORMALS_IN_FEATURE_DETECTION: Use normals for feature detection.

enumerator USED_ENTITY_COUNT: Number of used entities in group.

enumerator SEED_NODE: Seed node for region growing.

enumerator ONLY_CURVATURE_FROM_FLAT: Only use curvature from flat regions.

enumerator SEED_ELEMENT: Seed element for region growing.

enumerator SEED_EDGE: Seed edge for region growing.

enumerator SEED_FACE: Seed face for region growing.

enumerator NONMANIFOLD_EDGES_AS_FEATURE: Treat nonmanifold edges as features.

enumerator INCLUDE_FREE_ENTITIES: Include free entities in group.

enum class GroupFloatParameter

Floating point parameters for mesh groups.

Values:

enumerator FEATURE_ANGLE: Feature angle threshold for detection.

enumerator TOLERANCE: Tolerance for group operations.

enumerator CURVATURE_CHANGE: Curvature change threshold.

enum class GroupFloatArrayParameter

Floating point array parameters for mesh groups.

Values:

enumerator EXTENT: Extent (bounding box) for group selection.

enum class DemoShape

Built-In shapes for mesh generation.

Values:

enumerator CUBE: Cube shape.

enumerator CYLINDER: Cylinder shape.

enumerator SPHERE: Sphere shape.

enum class ReadFormat

Supported formats for mesh reading.

Values:

enumerator ASCII: ASCII format.

enumerator BINARY: Binary format.

enumerator STL: STL format (ASCII).

enumerator STL_BINARY: STL format (binary).

enumerator OBJ: OBJ format.

enum class WriteFormat

Supported formats for mesh writing.

Values:

enumerator ASCII: ASCII format.

enumerator BINARY: Binary format.

enumerator ABAQUS_INPUT: ABAQUS input file.

enumerator ANSYS_INPUT: ANSYS input file.

enumerator LS_DYNA_INPUT: LS-DYNA input file.

enumerator NASTRAN_BULKDATA: NASTRAN bulk data file.

enumerator PATRAN_NEUTRAL: PATRAN neutral file.

enumerator SDRC_UNIVERSAL: SDRC universal file.

Public Functions

ErrorCode getErrorCode()

Return the current ErrorCode of the Mesh object.

Returns:	`ErrorCode` - The current error code, or `NONE` if no error.

Status setPrecision(Precision precision)

Specify the precision used to maintain node coordinates. All previously defined nodes and elements are cleared by this function. This function should be called before define() . By default, node coordinates are held in single precision.

See Also getElementFaceNormals()

Parameters:	elementIndex – Element index faceNumber – Element face number normals – Normal vectors at face nodes
Returns:	Status

Status setElementFaceNormals(int elementIndex, int faceNumber, double normals[][3])

Set the normals to an element face at the element face nodes in double precision.

See Also getElementFaceNormals()

Parameters:	elementIndex – Element index faceNumber – Element face number normals – Normal vectors at face nodes
Returns:	Status

Status isElementFaceNormalsDefined(int elementIndex, int faceNumber, int *flag)

Query for element face normal definition. The flag is returned as 0 if the element face normals have not been set using setElementFaceNormals(), otherwise it is returned as 1.

Parameters:	elementIndex – Element index faceNumber – Element face number flag – [out] Defined flag
Returns:	Status

Status getElementFaceNormals(int elementIndex, int faceNumber, float normals[][3])

Get the normals to an element face at the element face nodes. The element face node connectivity order is as returned by getElementEntityConnectivity(). If the element face normals have not been previously set using setElementFaceNormals() then the face node normals are computed from the element geometry. Use isElementFaceNormalsDefined() to query if the face node normals have been previously set.

See Also getElementFaceNormals()

Parameters:	elementIndex – Element index faceNumber – Element face number normals – [out] Normal vectors at face nodes
Returns:	Status

Status getElementFaceNormals(int elementIndex, int faceNumber, double normals[][3])

Get the normals to an element face at the element face nodes in double precision.

See Also getElementFaceNormals()

Parameters:	elementIndex – Element index faceNumber – Element face number normals – [out] Normal vectors at face nodes
Returns:	Status

Status setElementEdgeTangent(int elementIndex, int edgeNumber, float tangents[][3])

Set the tangents to an element edge at the element edge nodes. The element edge node connectivity order is as returned by getElementEntityConnectivity().

See Also merge()

Errors: VALUE is generated if group is not a node group.

Parameters:	group – Pointer to Group object of nodes. If NULL, then all nodes are assumed. previousToNewNodeIndices – Pointer to IdTranslator object, mapping previous node indices to new indices
Returns:	Status

Status merge(Group *group)

Merge coincident nodes. Merge coincident nodes. The distance tolerance is set using setGroupFloatParameter() with parameter type TOLERANCE . The node coordinates and node associations are merged with coincident nodes. The lowest numbered node of a set of coincident nodes retains the node coordinates and associations for the set. The total number of nodes is reduced by the number of coincident nodes. Element connectivity is reordered to reflect the node renumbering. If an input node group is specified only the nodes appearing in the group are merged.

Errors: VALUE is generated if group is not a node group.

Parameters:	group – Pointer to Group object of nodes. If NULL, then all nodes are assumed.
Returns:	Status

Status getElementGroup(GroupOperation operation, Group *inputGroup, Group *outputGroup)

Derive a group of elements from an input group. Derive a group of elements from an input group of elements using a specified operation. The output outputGroup must have been previously created and defined as an element group. Note that outputGroup is not cleared by this function, in other words the derived element entities are added to any existing elements in the output outputGroup. The mesh kernel must be generated using generateKernel() before calling this function.

Errors

VALUE is generated if inputGroup is not an element group.

Parameters:

operation – Operation specified to derive group (see GroupOperation )
- ASSOCIATION Elements with an association value
- ENTITIES_WITH_ANY_ASSOCIATION_VALUE Elements with any association value
- CONNECTED_TO_N_NODES Element connections to nodes
- ENTITIES_WITH_ALL_NODES_IN_GROUP Element contained entirely by nodes
- ELEMENTS_OF_DIMENSION Elements of a given dimensionality
- WITHIN_EXTENT Elements lying in a coordinate box
- INCONSISTENT_2D_ELEMENTS Inconsistent connectivity
- ELEMENTS_WITH_EDGE_FACE_INTERSECTIONS Intersecting elements
- ELEMENTS_OF_SHAPE Elements of a given shape
inputGroup – Pointer to source Group object of elements or nodes. If NULL, then all elements are assumed.
outputGroup – [out] Pointer to derived Group object of elements

Returns:

Status

Status getFaceGroup(GroupOperation operation, Group *inputGroup, Group *outputGroup)

Derive a group of element faces from an input group. Derive a group of element faces from an input group of elements using a specified operation. The output outputGroup must have been previously created and defined as an element face group. The derived element face entities are added to any existing face entities in the output outputGroup. The mesh kernel must be generated using generateKernel() before calling this function.

Errors

OPERATION is generated if generateKernel() has not been previously called.
VALUE is generated if inputGroup is not an element group.

Parameters:

operation – Operation specified to derive group (see GroupOperation )
- ASSOCIATION Faces with an association value. Only valid for source element groups. The association type and id are specified using setGroupElementAssociationType() and setGroupIntegerParameter() with ASSOCIATION_ID .
- ENTITIES_WITH_ANY_ASSOCIATION_VALUE Faces with any association value. Only valid for source element groups. The association type is specified using setGroupElementAssociationType(). Any non-zero value of the specified association type will flag the face.
- DIFFERING_ASSOCIATION Faces where connected elements have differing association values. Only valid for source element groups. The association type is specified using setGroupElementAssociationType(). If any elements connected to a face have differing association values the face will be flagged. An option may be enabled to include free faces using setGroupIntegerParameter() with INCLUDE_FREE_ENTITIES .
- CONNECTED_TO_N_NODES Faces connected to a specified number of nodes. Only valid for source node groups. The number of node connections is specified using setGroupIntegerParameter() with USED_ENTITY_COUNT .
- ENTITIES_WITH_ALL_NODES_IN_GROUP Faces with all nodes in the source node group. Only valid for source node groups.
- CONNECTED_ENTITIES Faces of 2D elements. Only valid for source element groups. A 2D element is any element with a shape of TRIANGLE or QUADRILATERAL .
- FREE_ENTITIES Faces connected to only one element. Valid for source element groups.
- ENTITIES_PROPAGATING_FROM_SEED Faces propagating from a seed. Valid for source element face groups. A face is selected if it is connected to the specified seed node or seed element face, or is adjacent to a selected face and is in the source face group. The face adjacency neighborhood is bounded by a specified element edge seed group. A seed node is specified using setGroupIntegerParameter() with SEED_NODE . A seed element face is specified using setGroupIntegerParameter() with SEED_ELEMENT and SEED_FACE . A non-zero specified seed node takes priority over a specified element face. The bounding element edge group is specified using setSeedGroup().
- FIRST_ENTITY_OCCURRENCE First occurrence of each element face. Valid for source element groups. If two or more element faces are connected to the same nodes then only the element face of the lower numbered element is selected.
- ENTITIES_USED_BY_N_ELEMENTS Faces connected to a specified number of elements. Only valid for source element groups. The number of element uses is specified using setGroupIntegerParameter() with USED_ENTITY_COUNT .
- FEATURE_BOUND_FLOOD_FILL_ENTITIES Faces propagating from seed without crossing feature edges. Only valid for source element face groups. A face is selected if it is a free face, adjacent to a selected face or the seed element face without crossing a feature edge, and is in the source face group if not NULL. A seed element face is specified using setGroupIntegerParameter() with SEED_ELEMENT and SEED_FACE . The bounding element edge group is computed based on the FEATURE_ANGLE and USE_NORMALS_IN_FEATURE_DETECTION parameters.
inputGroup – Pointer to source Group object of elements or nodes. If NULL, then all elements are assumed.
outputGroup – [out] Pointer to derived Group object of element faces

Returns:

Status

Status getEdgeGroup(GroupOperation operation, Group *inputGroup, Group *outputGroup)

Derive a group of element edges from an input group. Derive a group of element edges from an input group of elements or element faces using a specified operation. The output outputGroup must have been previously created and defined as an element edge group. The derived element edge entities are added to any existing edge entities in the output outputGroup. The mesh kernel must be generated using generateKernel() before calling this function.

Errors

OPERATION is generated if generateKernel() has not been previously called.
VALUE is generated if inputGroup is not an element or element face group.

Parameters:

operation – Operation specified to derive group (see GroupOperation )
- ASSOCIATION Edges with an association value. Only valid for source element groups. The association type and id are specified using setGroupElementAssociationType() and setGroupIntegerParameter() with ASSOCIATION_ID .
- ENTITIES_WITH_ANY_ASSOCIATION_VALUE Edges with any association value. Only valid for source element groups. The association type is specified using setGroupElementAssociationType(). Any non-zero value of the specified association type will flag the edge.
- DIFFERING_ASSOCIATION Edges where connected elements have differing association values. Only valid for source element groups. The association type is specified using setGroupElementAssociationType(). If any elements connected to an edge have differing association values the edge will be flagged. An option may be enabled to include free edges using setGroupIntegerParameter() with INCLUDE_FREE_ENTITIES .
- CONNECTED_TO_N_NODES Edges connected to a specified number of nodes. Only valid for source node groups. The number of node connections is specified using setGroupIntegerParameter() with USED_ENTITY_COUNT .
- ENTITIES_WITH_ALL_NODES_IN_GROUP Edges with all nodes in the source node group. Only valid for source node groups.
- CURVATURE_DISCONTINUITY Edges at curvature discontinuity. Only valid for source element face groups. The curvature discontinuity tolerance is specified using setGroupFloatParameter() with CURVATURE_CHANGE .
- FEATURE Feature edges based on dihedral angle. Only valid for source element face groups. The feature angle tolerance is specified using setGroupFloatParameter() with FEATURE_ANGLE .
- FEATURE_ENTITY_PER_ASSOCIATION Feature edges per association value. Valid for source element face groups. All edges are flagged which satisfy the feature angle specifications connected to element faces sharing each association value.
- CONNECTED_ENTITIES Edges of 1D elements. Only valid for source element groups. A 1D element is any element with a shape of LINE .
- FREE_ENTITIES Edges connected to only one element or element face. Valid for source element and element face groups.
- FIRST_ENTITY_OCCURRENCE Edges connected to exactly two element faces. Valid for source element and element face groups.
- FIRST_ENTITY_OCCURRENCE_PER_ENTITY_ASSOCIATION Unique edges per association value. Valid for source element groups. All unique edges are flagged connected to elements sharing each association value.
- FIRST_ENTITY_OCCURRENCE_PER_FACE_ASSOCIATION Unique edges per face association value. Valid for source element face groups. All unique edges are flagged connected to element faces sharing each association value.
- ENTITIES_PROPAGATING_FROM_SEED Edges propagating from a seed. Valid for source element edge groups. An edge is selected if it is connected to the specified seed node or seed element edge, or is adjacent to a selected edge and is in the source edge group. The edge adjacency neighborhood is bounded by a specified node seed group. A seed node is specified using setGroupIntegerParameter() with SEED_NODE . A seed element edge is specified using setGroupIntegerParameter() with SEED_ELEMENT and SEED_EDGE . A non-zero specified seed node takes priority over a specified element edge. The bounding node group is specified using setSeedGroup().
- ENTITIES_USED_BY_N_ELEMENTS Edges connected to a specified number of elements. Only valid for source element groups. The number of element uses is specified using setGroupIntegerParameter() with USED_ENTITY_COUNT .
inputGroup – Pointer to source Group object of elements, element faces, or nodes. If NULL, then all elements are assumed.
outputGroup – [out] Pointer to derived Group object of element edges

Returns:

Status

Status getNodeGroup(GroupOperation operation, Group *inputGroup, Group *outputGroup)

Derive a group of nodes from an input group. Derive a group of nodes from an input group of elements, element faces, element edges or nodes using a specified operation. The output outputGroup must have been previously created and defined as a node group. The derived node entities are added to any existing node entities in the output outputGroup.

Errors

If operation is CONNECTED_ENTITIES , FEATURE , FREE_ENTITIES or FIRST_ENTITY_OCCURRENCE then OPERATION is generated if generateKernel() has not been previously called.
VALUE is generated if inputGroup is not an element, element face or element edge group.
If operation is ASSOCIATION , ENTITIES_WITH_ANY_ASSOCIATION_VALUE or WITHIN_EXTENT then VALUE is generated if inputGroup is not a node group.

Parameters:

operation – Operation specified to derive group (see GroupOperation )
- ASSOCIATION Nodes with an association value. Only valid for source node groups. The association type and id are specified using setGroupNodeAssociationType() and setGroupIntegerParameter() with ASSOCIATION_ID .
- ENTITIES_WITH_ANY_ASSOCIATION_VALUE Nodes with any association value. Only valid for source node groups. The association type is specified using setGroupNodeAssociationType(). Any non-zero value of the specified association type will flag the node.
- WITHIN_EXTENT Nodes within a coordinate box. Only valid for source node groups. The extent limits are specified using setGroupFloatParameterArray() with EXTENT .
- CORNER_NODES Corner nodes of elements. Valid for source element, element face and element edge groups. A node is selected if it is connected to the corner (as opposed to midside, midface or midbody) of an element, element face or element edge respectively. All nodes of linear elements are assumed to be corners.
- CONNECTED_ENTITIES Nodes connected to 0D elements. Only valid for source element groups. A node is selected if it is connected to a 0D element. A 0D element is any element with a shape of POINT .
- FEATURE Feature nodes based on angle between edges. Only valid for source element edge groups. The feature angle tolerance is specified using setGroupFloatParameter() with FEATURE_ANGLE .
- FREE_ENTITIES Free nodes. Valid for source element, element face and element edge groups. A node is selected if it is connected to only one element, element face or element edge respectively.
- FIRST_ENTITY_OCCURRENCE Nodes connected to any entity. Valid for source element, element face and element edge groups. A node is selected if it is connected to any element, element face or element edge respectively.
- ENTITIES_USED_BY_N_ELEMENTS Nodes used by a specified number of elements. Only valid for source element groups. The number of node uses is specified using setGroupIntegerParameter() with USED_ENTITY_COUNT .
inputGroup – Pointer to source Group object of elements, element faces, element edges or nodes. If NULL, then all elements or nodes are assumed.
outputGroup – [out] Pointer to derived Group object of nodes

Returns:

Status

Status getElementRegion(RegionOperation operation, Group *inputGroup, IdTranslator *elementRegion)

Derive regions of elements from an input group of elements using a specified operation. The regions are numbered sequentially from 1. The UNCONNECTED_REGIONS operation creates regions of connected elements which are not connected to any elements in any other region. The TOPOLOGICALLY_SIMILAR_BODIES operation creates regions of connected elements which are connected to topologically similar elements. The NODAL_AVERAGING_REGIONS operation creates regions of connected elements which are suitable for averaging element based result quantities to nodes.

Parameters:	operation – Operation specified to derive regions (see `RegionOperation` ) inputGroup – Pointer to source Group object of elements. If NULL, then all elements are assumed. elementRegion – [out] Pointer to IdTranslator of element regions
Returns:	Status

Status getNodeRegion(RegionOperation operation, Group *inputGroup, IdTranslator *elementRegion)

Derive regions of nodes from an input group of nodes or elements using a specified operation. The regions are numbered sequentially from 1. The UNCONNECTED_REGIONS operation creates regions of connected nodes which are not connected to any nodes in any other region (connectivity determined by element connectivity). The TOPOLOGICALLY_SIMILAR_BODIES operation creates regions of connected nodes which are connected via topologically similar elements.

Parameters:	operation – Operation specified to derive regions (see `RegionOperation` ) inputGroup – Pointer to source Group object of nodes or elements. If NULL, then all nodes are assumed. elementRegion – [out] Pointer to IdTranslator of node regions
Returns:	Status

Status splitElement(EntityType entityType, int elementIndex, int entityNumber, int nodeINdex)

Split element using a node index. Elements which may be split include 2 node lines, 3 node triangles and 4 node tetrahedra. The element connectivity is replaced by one of the elements resulting from the split. If the element is split then for lines one additional line element is generated, for triangles two additional triangle elements are generated, and for tetrahedra three additional tetrahedral elements are generated. If the element edge is split then all elements adjacent to the element across the specified edge are split. An adjacent element is not split if the element is not a simplex of the same shape.

Errors

VALUE is generated if an improper elementIndex or nodeIndex is specified.
OPERATION is generated if the element is not a simplex element.

Parameters:	entityType – Type of element feature ( `ELEMENT` , `FACE` , or `EDGE` ) elementIndex – Element index entityNumber – Element face or edge number nodeIndex – Node index used to split element
Returns:	Status

Status getElementSize(EntityType entityType, int elementIndex, int entityNumber, double *size)

Compute a measure of element size for the specified element. For volume elements, the size is the volume. For surface elements, the size is the area. For line elements, the size is the length.

Errors

VALUE is generated if an improper elementIndex or nodeIndex is specified.

Parameters:	entityType – Type of element feature ( `ELEMENT` , `FACE` , or `EDGE` ) elementIndex – Element index entityNumber – Element face or edge number size – [out] Computed element size
Returns:	Status

Status copy(Mesh *from)

Copy all nodes, elements, topology, connectivity, and associations from the source Mesh object.

Parameters:	from – Pointer to source Mesh object
Returns:	Status

Status append(Mesh *from)

Append the contents of the source Mesh object to this Mesh. If the user node or element identifiers in the source are equal to the node or element index respectively, then the user node or element identifiers are offset by the maximum user node or element identifiers in this object. If the identifiers are not equal to the index, then the user node or element identifiers from the source are set directly.

Parameters:	from – Pointer to source Mesh object
Returns:	Status

Status extractSubset(Group *group, Mesh *subset, IdTranslator *childToParentNodeIndices)

Extract a subset of this Mesh and place it in the subset Mesh. The subset is specified by the source group of elements. All nodes connected to the specified elements are extracted. The node IdTranslator object is filled with the parent node indices of the extracted nodes.

Parameters:	group – Pointer to source Group object of elements subset – Pointer to subset Mesh object childToParentNodeIndices – Pointer to node IdTranslator object of parent node indices
Returns:	Status

Status extractSubsetWithElementMapping(Group *group, Mesh *subset, IdTranslator *childToParentNodeIndices, IdTranslator *childToParentElementIndices)

Extract a subset of this Mesh and place it in the subset Mesh. The subset is specified by the source group of elements. All nodes connected to the specified elements are extracted. The node IdTranslator object is filled with the parent node indices of the extracted nodes. The element IdTranslator object is filled with the parent element indices of the extracted elements.

Parameters:	group – Pointer to source Group object of elements subset – Pointer to subset Mesh object childToParentNodeIndices – Pointer to node IdTranslator object of parent node indices childToParentElementIndices – Pointer to element IdTranslator object of parent element indices
Returns:	Status

Status print()

Print detailed mesh information including nodes, elements, topology, and connectivity.

Returns:	Status

Status printSummary()

Print a summary of mesh statistics including node count, element count, and element type distribution.

Returns:	Status

Status tesselate(Mesh *input)

Tesselate higher order elements (quadratic, cubic) in the input Mesh to linear elements (with straight edges) in this Mesh. The tesselation process subdivides each higher order element into multiple linear elements.

Parameters:	input – Pointer to input Mesh object containing higher order elements
Returns:	Status

Status getMeshInterfacePointers(MeshInterface *functions)

Retrieve function pointers to the internal mesh interface functions.

Parameters:	functions – Pointer to MeshInterface object
Returns:	Status

int checkElementIndex(int index, const char *errorFunction)

Check if the specified element index is valid and defined.

Parameters:	index – Element index to check errorFunction – Name of calling function for error reporting
Returns:	1 if element is valid, 0 otherwise

Status getIntersectionPlane(double planeEquation[4], Group *inputGroup, Group *outputGroup)

Compute the intersection of elements in the input group with a plane defined by a plane equation. The intersection creates a group of element faces or edges.

Parameters:	planeEquation – Plane equation coefficients [A,B,C,D] where Ax+By+Cz+D=0 inputGroup – Pointer to input Group object of elements outputGroup – [out] Pointer to output Group object containing intersection entities
Returns:	Status

Status setThreadCount(int count)

Set the number of threads to use for parallel mesh operations.

Parameters:	count – Number of threads to use
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status setNodeAssociation(int index, AssociationValue association)

Set node association, association, for a specified node index. The association type is specified as a template parameter to ensure type safety. Use getNodeAssociation() to retrieve node associations. Note that setCoordinates() sets a default node type. The node type, NODE_TYPE , association should be set to one of the cae::core::NodeType constants.

Example usage:

mesh->setNodeAssociation<NodeAssociationType::USER_ID>(nodeIndex, userId);
mesh->setNodeAssociation<NodeAssociationType::NODE_TYPE>(nodeIndex, NodeType::GRID);

Errors

VALUE is generated if an improper node index is specified.
VALUE is generated if an improper USER_ID .

Template Parameters:
	AssociationType – `NodeAssociationType` AssociationValue – Type of the association value (int, `NodeType` , etc.)
Parameters:	index – Node index to set association association – Node association value
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status getNodeAssociation(int indexCount, int indexes[], AssociationValue associations[])

Get node associations, associations, for a set of specified nodes indexes. If a node association has not been defined for a node index, zero is returned, except for the case USER_ID . In this case the return value is dependent upon the ZERO_USER_ID parameter set using setIntegerParameter(). By default if the value has not been set or has been set to zero the node index is returned as the association. Use setNodeAssociation() to set node associations.

Example usage:

mesh->getNodeAssociation<NodeAssociationType::USER_ID>(count, nodeIndices, associations);
mesh->getNodeAssociation<NodeAssociationType::NODE_TYPE>(count, nodeIndices, nodeTypes);

Template Parameters:
	AssociationType – from `NodeAssociationType` AssociationValue – Type of the association value (int, `NodeType` , etc.)
Parameters:	indexCount – Number of node indices to get associations indexes – Vector of node indices. associations – [out] Vector of node associations
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status addNodeAssociation(int index, AssociationValue association)

Add a node association, association, for a specified node, index. Use deleteNodeAssociation() to delete any added associations at a node.

Example usage:

mesh->addNodeAssociation<NodeAssociationType::PART_ID>(nodeIndex, partId);

Errors

VALUE is generated if an improper node index is specified.
VALUE is generated if an improper USER_ID .

Template Parameters:
	AssociationType – from `NodeAssociationType` AssociationValue – Type of the association value (int, `NodeType` , etc.)
Parameters:	index – Node index association – Association value
Returns:	Status

template<auto AssociationType> Status deleteNodeAssociation(int index)

Delete any node associations added at a specified node, index. The association type is specified as a template parameter to ensure type safety. Only those associations specified by addNodeAssociation() are deleted.

Example usage:

mesh->deleteNodeAssociation<NodeAssociationType::PART_ID>(nodeIndex);

Errors

VALUE is generated if an improper node index is specified.

Template Parameters:
	AssociationType – from `NodeAssociationType`
Parameters:	index – Node index
Returns:	Status

template<auto AssociationType> Status getNodeAssociationCount(int index, int *count)

Query for the total number, count >= 1 of node associations at a specified node, index. The number, count, is returned as 1 if no additional associations have been added at the node using addNodeAssociation().

Example usage:

mesh->getNodeAssociationCount<NodeAssociationType::USER_ID>(nodeIndex, &count);

Errors

VALUE is generated if an improper node index is specified.

Template Parameters:
	AssociationType – from `NodeAssociationType`
Parameters:	index – Node index count – [out] Total number of node associations
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status getAllNodeAssociations(int index, int *count, AssociationValue associations[])

Query for all node associations at a specified node, index. The total number of node associations, count >= 1 is returned as well as count associations in vector associations. The single association set using setNodeAssociation() is always the first entry in associations. The number, count, is returned as 1 if no additional associations have been added at the node using addNodeAssociation().

Example usage:

mesh->getAllNodeAssociations<NodeAssociationType::PART_ID>(nodeIndex, &count, associations);
mesh->getAllNodeAssociations<NodeAssociationType::NODE_TYPE, NodeType>(nodeIndex, &count, nodeTypes);

Errors

VALUE is generated if an improper node index is specified.

Template Parameters:
	AssociationType – from `NodeAssociationType` AssociationValue – Type of the association value (int, `NodeType` , etc.)
Parameters:	index – Node index count – [out] Total number of node associations associations – [out] Associations
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status setElementAssociation(int index, AssociationValue association)

Set element association, association, for a specified element index. The association type is specified as a template parameter to ensure type safety. Use getElementAssociation() to retrieve element associations. Note that setTopology() sets a default element type. The element type, ELEMENT_TYPE , association should be set to one of the ElementType constants ElementType . The end connection, ELEMENT_END_A_CONNECTION or ELEMENT_END_B_CONNECTION , associations specify certain point and line connections. These associations are required if the geometric location of an element end point is offset in some respect from the geometric location of the node connectivity at which the degrees of freedom are located. An example would be beam element offset vectors. A positive value indicates a node number. A zero value means that the element end point is colocated with the node connectivity A negative value is identified by one of the ElementEndType . The element type, ELEMENT_TYPE , association should be set to one of the following constants ElementType . The specific element type, SpecificType , association should be set to one of the following constants depending upon the element type. For 2-D elements, the element two dimension type, ELEMENT_TYPE_2D , association should be set to one of the following non-zero constants AnalysisType2D . Any element which is not a 2-D element will have an association value of zero. The element technology, ELEMENT_TECHNOLOGY , association is designed to be set to one of the following constants ElementTechnology .

Example usage:

mesh->setElementAssociation<ElementAssociationType::USER_ID>(elemIndex, userId);
mesh->setElementAssociation<ElementAssociationType::ELEMENT_TYPE>(elemIndex, cae::core::ElementType::SPRING_DASHPOT);
mesh->setElementAssociation<ElementAssociationType::ELEMENT_SPECIFIC_TYPE>(elemIndex, cae::core::SpecificType::SPRINGDASHPOT_BUSH);

Errors

VALUE is generated if an improper element index is specified.

Template Parameters:
	AssociationType – from `ElementAssociationType` AssociationValue – Type of the association value (int, `ElementType` , `SpecificType` , etc.)
Parameters:	index – Element index to set association association – Element association value
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status getElementAssociation(int indexCount, int indexes[], AssociationValue associations[])

Get element associations, associations, for a set of specified elements indexes. The association type is specified as a template parameter to ensure type safety. If an element association has not been defined for an element index, zero is returned, except for the case USER_ID . In this case the return value is dependent upon the ZERO_USER_ID parameter set using setIntegerParameter(). By default if the value has not been set or has been set to zero the element index is returned as the association. Use setElementAssociation() to set element associations.

Example usage:

mesh->getElementAssociation<ElementAssociationType::PROPERTY_ID>(count, elemIndices, associations);
mesh->getElementAssociation<ElementAssociationType::ELEMENT_TYPE>(count, elemIndices, elemTypes);

Template Parameters:
	AssociationType – from `ElementAssociationType` AssociationValue – Type of the association value (int, `ElementType` , `SpecificType` , etc.)
Parameters:	indexCount – Number of element indices to get associations indexes – Vector of element indices. associations – [out] Vector of element associations
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status addElementAssociation(int index, AssociationValue association)

Add an element association, association, for a specified element, index. Use deleteElementAssociation() to delete any added associations at an element.

Example usage:

mesh->addElementAssociation<ElementAssociationType::MATERIAL_ID>(elemIndex, materialId);

Errors

VALUE is generated if an improper element index is specified.

Template Parameters:
	AssociationType – from `ElementAssociationType` AssociationValue – Type of the association value (int, `ElementType` , `SpecificType` , etc.)
Parameters:	index – Element index association – Association value
Returns:	Status

template<auto AssociationType> Status deleteElementAssociation(int index)

Delete any element associations added at a specified element, index. Only those associations specified by addElementAssociation() are deleted.

Example usage:

mesh->deleteElementAssociation<ElementAssociationType::MATERIAL_ID>(elemIndex);

Errors

VALUE is generated if an improper element index is specified.

Template Parameters:
	AssociationType – from `ElementAssociationType`
Parameters:	index – Element index
Returns:	Status

template<auto AssociationType> Status getElementAssociationCount(int index, int *count)

Query for the total number, count >= 1 of element associations at a specified element, index. The number, count, is returned as 1 if no additional associations have been added at the element using addElementAssociation().

Example usage:

mesh->getElementAssociationCount<ElementAssociationType::PROPERTY_ID>(elemIndex, &count);

Errors

VALUE is generated if an improper element index is specified.

Template Parameters:
	AssociationType – from `ElementAssociationType`
Parameters:	index – Element index count – [out] Total number of element associations
Returns:	Status

template<auto AssociationType, typename AssociationValue> Status getAllElementAssociations(int index, int *count, AssociationValue associations[])

Query for all element associations at a specified element, index. The total number of element associations, count >= 1 is returned as well as count associations in vector associations. The single association set using setElementAssociation() is always the first entry in associations. The number, count, is returned as 1 if no additional associations have been added at the element using addElementAssociation().

Example usage:

mesh->getAllElementAssociations<ElementAssociationType::PART_ID>(elemIndex, &count, associations);
mesh->getAllElementAssociations<ElementAssociationType::ELEMENT_TYPE>(elemIndex, &count, elemTypes);

Errors

VALUE is generated if an improper element index is specified.

Template Parameters:
	AssociationType – from `ElementAssociationType` AssociationValue – Type of the association value (int, `ElementType` , `SpecificType` , etc.)
Parameters:	index – Element index count – [out] Total number of element associations associations – [out] Associations
Returns:	Status

Mesh

Overview

Mesh Initialization and Configuration

Node and Element Editing and Element Adjacency Query

Node and Element Associations

Common Association Types

Working with Associations

Element Entity Associations

Multiple Associations

Part Names and IJK Structure

Deriving Element, Face, Edge and Node Groups

Group Derivation Parameters

Face Groups for Display

Edge Groups for Display

Element Face Normals and Edge Tangents

Geometric Tessellation

Using MeshInterface for External Data

Class Members Descriptions

Hello! I'm HOOPSY