Function t8_forest_set_scheme(t8_forest_t, const t8_scheme_c *)

Function Documentation

void t8_forest_set_scheme(t8_forest_t forest, const t8_scheme_c *scheme)

Set the element scheme associated to a forest. By default, the forest takes ownership of the scheme such that it will be destroyed when the forest is destroyed. To keep ownership of the scheme, call t8_scheme_ref before passing it to t8_forest_set_scheme. This means that it is ILLEGAL to continue using scheme or dereferencing it UNLESS it is referenced directly before passing it into this function.

Parameters:

  • forest – [inout] The forest whose scheme variable will be set.

  • scheme – [in] The scheme to be set. We take ownership. This can be prevented by referencing scheme.