t8_forest_types.h File Reference

We define here the datatypes needed for internal forest routines. More...

#include <t8.h>
#include <sc_statistics.h>
#include <t8_refcount.h>
#include <t8_cmesh.h>
#include <t8_element.h>
#include <t8_data/t8_containers.h>
#include <t8_forest/t8_forest_adapt.h>
#include <t8_forest/t8_forest_general.h>

Go to the source code of this file.

Data Structures
struct	t8_forest
	This structure is private to the implementation. More...
struct	t8_tree
	The t8 tree datatype. More...
struct	t8_profile
struct	t8_forest_ghost

Macros
#define	T8_FOREST_FROM_FIRST   0
#define	T8_FOREST_FROM_COPY   0 /* must be zero, such that |= with another options overwrites it */
#define	T8_FOREST_FROM_ADAPT   0x1
#define	T8_FOREST_FROM_PARTITION   0x2
#define	T8_FOREST_FROM_BALANCE   0x4
#define	T8_FOREST_FROM_NONE   0x8 /* A value that is not reached by adding up the other values. No from method used */
#define	T8_FOREST_FROM_LAST   T8_FOREST_FROM_NONE
#define	T8_FOREST_BALANCE_REPART   1
	Value of forest->set_balance if balancing with repartitioning.
#define	T8_FOREST_BALANCE_NO_REPART   2
	Value of forest->set_balance if balancing without repartitioning.
#define	T8_PROFILE_NUM_STATS   14
	The number of statistics collected by a profile struct. More...
#define	T8_PROFILE_NUM_STATS   14
	The number of statistics collected by a profile struct. More...

Typedefs
typedef struct t8_profile	t8_profile_t
typedef struct t8_forest_ghost *	t8_forest_ghost_t
typedef int8_t	t8_forest_from_t
	If a forest is to be derived from another forest, there are different possibilities how the original forest is modified. More...
typedef struct t8_forest	t8_forest_struct_t
	This structure is private to the implementation.
typedef struct t8_tree	t8_tree_struct_t
	The t8 tree datatype.
typedef struct t8_profile	t8_profile_struct_t
typedef struct t8_forest_ghost	t8_forest_ghost_struct_t

Detailed Description

We define here the datatypes needed for internal forest routines.

Macro Definition Documentation

T8_PROFILE_NUM_STATS [1/2]

#define T8_PROFILE_NUM_STATS   14

The number of statistics collected by a profile struct.

This struct is used to profile forest algorithms.

The forest struct stores a pointer to a profile struct, and if it is nonzero, various runtimes and data measurements are stored here.

See also

t8_cmesh_set_profiling and

t8_cmesh_print_profile The number of statistics collected by a profile struct.

T8_PROFILE_NUM_STATS [2/2]

#define T8_PROFILE_NUM_STATS   14

The number of statistics collected by a profile struct.

This struct is used to profile forest algorithms.

The forest struct stores a pointer to a profile struct, and if it is nonzero, various runtimes and data measurements are stored here.

See also

t8_cmesh_set_profiling and

t8_cmesh_print_profile The number of statistics collected by a profile struct.

Typedef Documentation

t8_forest_from_t

typedef int8_t t8_forest_from_t

If a forest is to be derived from another forest, there are different possibilities how the original forest is modified.

Currently we support: Copying, adapting, partitioning, and balancing a forest. The latter 3 can be combined, in which case the order is

1. Adapt, 2. Partition, 3. Balance. We store the methods in an int8_t and use these defines to distinguish between them.