CCTK_InterpGridArrays() Return Codes

The return code from CCTK_InterpGridArrays()^part732is determined as follows:

• If any of the arguments are invalid (e.g. $\verb\vert N_dims\vert < 0$), the return code is UTIL_ERROR_BAD_INPUT.
• If any errors are encountered when processing the parameter table, the return code is the appropriate UTIL_ERROR_TABLE_* error code.
• If the query call determines that the number of ghost zones in the grid is too small for the local interpolator, the return code is CCTK_ERROR_INTERP_POINT_OUTSIDE.
• Otherwise, the return code from CCTK_InterpGridArrays() is the minimum over all processors of the return code from the local interpolation on that processor.

If the local interpolator supports per-point status returns and the user supplies an interpolator parameter table, then in addition to this global interpolation return code, CCTK_InterpGridArrays() also returns a ``local'' status code which describes the outcome of the local interpolation for all the interpolation points which originated on this processor:

  CCTK_INT local_interpolator_status;

This gives the minimum over all the interpolation points originating on this processor, of the CCTK_InterpLocalUniform() return codes for those points. (It doesn't matter on which processor(s) the points were actually interpolated - CCTK_InterpGridArrays() takes care of gathering all the status information back to the originating processors.)