Find default coordinate fields

saf_find_default_coords is a function defined in field.c.

Synopsis:

SAF_Field * saf_find_default_coords(SAF_ParMode pmode, SAF_Set *base, SAF_Field *field)

Formal Arguments:

  • pmode: The parallel mode
  • base: The set for which the default coordinate field is returned
  • field: [OUT] The returned field handle, if found, otherwise SAF__NOT_SET_FIELD

Description: Use this function to find the default coordinate fields of a set. There is only ever one default coordinate field for a set.

Preconditions:

  • pmode must be valid. (low-cost)
  • base must be a valid set handle for participating processes. (low-cost)

Return Value: On success, returns a pointer to the default coordinate field. If the field argument was supplied then it is filled in and becomes the return value, otherwise a new field link is allocated and returned. Returns NULL on failure. If no default coordinate field has been assigned to the base set then a valid object link is returned but that link is nil (i.e., a call to :file:`SS_PERS_ISNULL ../sslib_refman.rest/SS_PERS_ISNULL.rst` on the return value is true but the return value is not a NULL C pointer).

See Also:

  • Fields: Introduction for current chapter