udfGetElmIds()

Return the user element numbers.

Syntax

elemIds = udfGetElmIds( udfHd ) ;

Type

User Defined Element

Parameters

udfHd
The opaque handle (pointer) which was passed to the user function.

Return Value

elemIds (Integer*)
Pointer to one-dimensional integer array of user element numbers. This array has a dimension of number of elements, nItems.

Description

This routine returns the array of user element numbers. This is the first array column of the parameter elements of the command ELEMENT_SET in the input file. For example,
Integer* elemIds ;
Integer usrElem, elem ;
...
elemIds = udfGetElmIds( udfHd ) ;
for ( elem = 0 ; elem < nItems ; elem++ ) {
   usrElem = elemIds[elem] ;
 ...
}

Errors

  • This routine expects a valid udfHd.
  • This routine may only be called within a Body Force, Material Model or Component Model user function.