udfGetPbcIds()

Return the periodic boundary condition user node-pair numbers.

Syntax

pairIds = udfGetPbcIds( udfHd ) ;

Type

AcuSolve User-Defined Problem Boundary Condition

Parameters

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

Return Value

pairIds (Integer*)
Pointer to one dimensional integer array of user node-pair numbers. This array has a dimension of number of node-pairs, nItems.

Description

This routine returns the array of user node-pair numbers. For example,
Integer* pairIds ;
Integer usrPair, pair ;
...
PairIds = udfGetPbcIds( udfHd ) ;
for ( pair = 0 ; pair < nItems ; pair++ ) {
   usrPair = pairIds[pair] ;
   ...
}

Errors

  • This routine expects a valid udfHd.
  • This routine may only be called within a Periodic Boundary Condition user function.