Declare default coordinates of a given set

saf_declare_default_coords is a function defined in field.c.

Synopsis:

int saf_declare_default_coords(SAF_ParMode pmode, SAF_Set *base, SAF_Field *field)

Formal Arguments:

  • pmode: the parallel mode
  • base: the base space set whose default coordinates are being declared
  • field: the field to serve as the default coordinates

Description: Many fields might be suitable to serve as a coordinate field. Absolute coordinates and displacements are just two examples. This reference manual is not the appropriate place to go into the specific mathematical requirements for a field to serve as a coordinate field. However, recognizing that more than one field can serve as a coordinate field raises the issue, which field should be used as the coordinate field if nothing else is specified. This function declares which field ought to be treated as the default coordinates.

Note that in order for a field to be declared as the default coordinate field for a set, the field must first be declared as a coordinate field.

Preconditions:

  • pmode must be valid. (low-cost)
  • base must be a valid set handle. (low-cost)
  • field must be a valid field handle. (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:

  • Fields: Introduction for current chapter