udfGetElmMedium()

Return the medium of the element set.

Syntax

name = udfGetElmMedium( udfHd ) ;

Type

User Defined Element

Parameters

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

Return Value

name (integer)

Symbolic name corresponding to the medium of the element set.

PRM_MED_FLUID: Fluid.
PRM_MED_SOLID: Solid.
PRM_MED_SHELL: Shell.

Description

This routine returns the symbolic name for the medium (fluid, solid, or shell) of the element set associated with the user function. For example,

Integer medium ;
...
medium = udfGetElmMedium( udfHd ) ;
if ( medium == PRM_MED_FLUID ) {
...
}

Errors

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