Declare a field as a candidate coordinate field

saf_declare_coords is a function defined in field.c.

Synopsis:

int saf_declare_coords(SAF_ParMode pmode, SAF_Field *field)

Formal Arguments:

  • pmode: The parallel mode.
  • field: The field to be characterized as a coordinate field.

Description: Use the function to indicate that a particular field is a coordinate field. This merely identifies a field as a candidate coordinate field. More than one field may serve as the coordinate field for a set. For example, in engineering codes, there are the deformed and un-deformed coordinates.

Preconditions:

  • pmode must be valid. (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