Get a description of a suite

saf_describe_suite is a function defined in suite.c.

Synopsis:

int saf_describe_suite(SAF_ParMode pmode, SAF_Suite *suite, char **name, int *num_space_sets, SAF_Set **mesh_space, SAF_Set **param_space)

Formal Arguments:

  • pmode: The parallel mode.
  • suite: A suite handle.
  • name: [OUT] The returned name of the suite. Pass NULL if you do not want this value returned.
  • num_space_sets: [OUT] The number of sets returned in mesh_space.
  • mesh_space: [OUT] The returned array of sets representing the computational meshes associated with each state of the suite. This is the list of sets in the “SAF__SPACE_SLICE” collection.
  • param_space: [OUT] The returned array of sets representing the parametric space, such as time. These are associated with the histories of the suite and are thus contained in the “SAF__PARAM_SLICE” collection. This will not be implemented at this time.

Description: Returns the description of a suite. This includes the name of the suite and the sets associated with the “SAF__SPACE_SLICE” and “SAF__PARAM_SLICE” collections.

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:

  • Suites: Introduction for current chapter