Find coordinate fields¶
saf_find_coords
is a function defined in field.c.
Synopsis:
Formal Arguments:
pmode
: The parallel mode.db
: Database in which to limit the search.base
: The base space for which coordinate fields are desired.num
: For this and the succeeding argument [see Returned Handles].found
: For this and the preceding argument [see Returned Handles].
Description: Use this function to find the coordinate fields of a set. In general, we allow for more than one coordinate field to be defined. For example, in engineering codes, there are the deformed and undeformed coordinates. Thus, this function can return multiple fields. Even so, there is only ever one field known as the default coordinate field for a set. This field is found with a call to saf_find_default_coords.
Preconditions:
pmode
must be valid. (low-cost)base
must be either a valid set handle or the universe set for all participating processes. (low-cost)num
andfound
must be compatible for return value allocation. (low-cost)
Return Value: The constant SAF__SUCCESS
is returned when this function is successful. Otherwise this function either returns
an error number or throws an exception, depending on the value of the library’s error handling property.
See Also:
- saf_find_default_coords: 16.15: Find default coordinate fields
- Fields: Introduction for current chapter