p4est_quadrant::p4est_quadrant_data Union Reference

Union for quadrant data. More...

#include <p4est.h>

Data Fields
void *	user_data
	never changed by p4est
long	user_long
	never changed by p4est
int	user_int
	never changed by p4est
p4est_topidx_t	which_tree
	the tree containing the quadrant (used in auxiliary octants such as the ghost octants in p4est_ghost_t)
struct {
p4est_topidx_t   which_tree
int   owner_rank
}	piggy1
	of ghost octants, store the tree and owner rank; not part of the API
struct {
p4est_topidx_t   which_tree
p4est_topidx_t   from_tree
}	piggy2
	of transformed octants, store the original tree and the target tree; not part of the API
struct {
p4est_topidx_t   which_tree
p4est_locidx_t   local_num
}	piggy3
	of ghost octants, store the tree and index in the owner's numbering; only part of the API in p4est_ghost_t::ghosts

Detailed Description

Union for quadrant data.

It is important to notice that piggy1 and piggy2 are only used internally. Hence, they are not part of the API.

Usually piggy3 is also not part of the API. The only exception holds for quadrants in the ghosts array of p4est_ghost_t (cf. documentation of ghosts).

---

The documentation for this union was generated from the following file:

• src/p4est.h