Get description of topological relation

saf_describe_topo_relation is a function defined in rel.c.

Synopsis:

int saf_describe_topo_relation(SAF_ParMode pmode, SAF_Rel *rel, SAF_Set *set, SAF_Cat *pieces, SAF_Set *range_set, SAF_Cat *range_cat, SAF_Cat *storage_decomp, SAF_RelRep *trtype, hid_t *data_type)

Formal Arguments:

  • pmode: The parallel mode.
  • rel: The relation to be described.
  • set: [OUT] The containing set of the collection that is sewn together by the relation.
  • pieces: [OUT] The collection of members that are sewn together.
  • range_cat: [OUT] Together the RANGE_S and RANGE_C pair identifies the collection used to glue the pieces together.
  • storage_decomp: [OUT] The decomposition of set upon which the relation is actually stored.
  • trtype: [OUT] The topology relation type.
  • data_type: [OUT] The type of the data.

Description: This function returns information about a topological relation.

Preconditions:

  • pmode must be valid. (low-cost)
  • rel must be a valid relation handle for all participating processes. (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: