Get a description of a field template

saf_describe_field_tmpl is a function defined in ftempl.c.

Synopsis:

int saf_describe_field_tmpl(SAF_ParMode pmode, SAF_FieldTmpl *ftmpl, char **name, SAF_Algebraic *alg_type, SAF_Basis *basis, SAF_Quantity *quantity, int *num_comp, SAF_FieldTmpl **ctmpl)

Formal Arguments:

  • pmode: The parallel mode.
  • ftmpl: The field template to be described.
  • name: [OUT] The returned name. Pass NULL if you do not want the name returned. (see *Returned Strings*).
  • alg_type: [OUT] The returned algebraic type. Pass NULL if you do not want the type returned.
  • basis: [OUT] The returned basis. Pass null if you do not want the basis returned.
  • quantity: [OUT] The returned quantity. Pass null if you do not want the name returned.
  • num_comp: [OUT] The returned number of components. Pass NULL if you do not want the name returned. Note that if the field template is assocaited with an INhomogeneous field, the returned value will always be SAF__NOT_APPLICABLE_INT.
  • ctmpl: [OUT] The returned array of component field template handles. Pass NULL if you do not want the array returned. If the field template is associated with an INhomogeneous field, the returned value, if requested, will always be NULL. (If the field template does not point to other field templates then this argument will be untouched by this function.)

Description: This function returns information about a field template.

Preconditions:

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