udfGetElmName()

Return the user-given name of the element set.

Syntax

name = udfGetElmName( udfHd ) ;

Type

User Defined Element

Parameters

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

Return Value

name (string)
User-given name of the element set.

Description

This routine returns the user-given name of the element set associated with the user function. This facilitates correlating with the input file. For example,
String user_name ;
...
user_name = udfGetElmName( udfHd ) ;
udfPrintMess( "Inside element set with name <%s>", user_name ) ;

Errors

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