t8_forest_profiling.h File Reference

We define the forest of trees in this file. More...

#include <sc_statistics.h>

Go to the source code of this file.

Functions
void	t8_forest_set_profiling (t8_forest_t forest, int set_profiling)
	Enable or disable profiling for a forest. More...
void	t8_forest_compute_profile (t8_forest_t forest)
const sc_statinfo_t *	t8_forest_profile_get_adapt_stats (t8_forest_t forest)
const sc_statinfo_t *	t8_forest_profile_get_ghost_stats (t8_forest_t forest)
const sc_statinfo_t *	t8_forest_profile_get_partition_stats (t8_forest_t forest)
const sc_statinfo_t *	t8_forest_profile_get_commit_stats (t8_forest_t forest)
const sc_statinfo_t *	t8_forest_profile_get_balance_stats (t8_forest_t forest)
const sc_statinfo_t *	t8_forest_profile_get_balance_rounds_stats (t8_forest_t forest)
void	t8_forest_print_profile (t8_forest_t forest)
	Print the collected statistics from a forest profile. More...
double	t8_forest_profile_get_adapt_time (t8_forest_t forest)
	Get the runtime of the last call to t8_forest_adapt. More...
double	t8_forest_profile_get_partition_time (t8_forest_t forest, int *procs_sent)
	Get the runtime of the last call to t8_forest_partition. More...
double	t8_forest_profile_get_balance_time (t8_forest_t forest, int *balance_rounds)
	Get the runtime of the last call to t8_forest_balance. More...
double	t8_forest_profile_get_ghost_time (t8_forest_t forest, t8_locidx_t *ghosts_sent)
	Get the runtime of the last call to t8_forest_create_ghosts. More...
double	t8_forest_profile_get_ghostexchange_waittime (t8_forest_t forest)
	Get the waittime of the last call to t8_forest_ghost_exchange_data. More...

Detailed Description

We define the forest of trees in this file.

Function Documentation

t8_forest_print_profile()

void t8_forest_print_profile

(

t8_forest_t

forest

)

Print the collected statistics from a forest profile.

Parameters

[in]

forest

The forest.

forest must be committed before calling this function.

See also

t8_forest_set_profiling

t8_forest_profile_get_adapt_time()

double t8_forest_profile_get_adapt_time

(

t8_forest_t

forest

)

Get the runtime of the last call to t8_forest_adapt.

Parameters

[in]

forest

The forest.

Returns

The runtime of adapt if profiling was activated. 0 otherwise. forest must be committed before calling this function.

See also

t8_forest_set_profiling

t8_forest_set_adapt

t8_forest_profile_get_balance_time()

double t8_forest_profile_get_balance_time	(	t8_forest_t	forest,
		int *	balance_rounds
	)

Get the runtime of the last call to t8_forest_balance.

Parameters

[in]	forest	The forest.
[out]	balance_rounts	On output the number of rounds in balance if profiling was activated.

Returns

The runtime of balance if profiling was activated. 0 otherwise. forest must be committed before calling this function.

See also

t8_forest_set_profiling

t8_forest_set_balance

t8_forest_profile_get_ghost_time()

double t8_forest_profile_get_ghost_time	(	t8_forest_t	forest,
		t8_locidx_t *	ghosts_sent
	)

Get the runtime of the last call to t8_forest_create_ghosts.

Parameters

[in]	forest	The forest.
[out]	ghosts_sent	On output the number of ghost elements sent to other processes if profiling was activated.

Returns

The runtime of ghost if profiling was activated. 0 otherwise. forest must be committed before calling this function.

See also

t8_forest_set_profiling

t8_forest_set_ghost

t8_forest_profile_get_ghostexchange_waittime()

double t8_forest_profile_get_ghostexchange_waittime

(

t8_forest_t

forest

)

Get the waittime of the last call to t8_forest_ghost_exchange_data.

Parameters

[in]

forest

The forest.

Returns

The time of ghost_exchange_data that was spent waiting for other MPI processes, if profiling was activated. 0 otherwise. forest must be committed before calling this function.

See also

t8_forest_set_profiling

t8_forest_ghost_exchange_data

t8_forest_profile_get_partition_time()

double t8_forest_profile_get_partition_time	(	t8_forest_t	forest,
		int *	procs_sent
	)

Get the runtime of the last call to t8_forest_partition.

Parameters

[in]	forest	The forest.
[out]	procs_sent	On output the number of processes that this rank sent elements to in partition if profiling was activated.

Returns

The runtime of partition if profiling was activated. 0 otherwise. forest must be committed before calling this function.

See also

t8_forest_set_profiling

t8_forest_set_partition

t8_forest_set_profiling()

void t8_forest_set_profiling	(	t8_forest_t	forest,
		int	set_profiling
	)

Enable or disable profiling for a forest.

If profiling is enabled, runtimes and statistics are collected during forest_commit.

Parameters

[in,out]	forest	The forest to be updated.
[in]	set_profiling	If true, profiling will be enabled, if false disabled.

Profiling is disabled by default. The forest must not be committed before calling this function.

See also

t8_forest_print_profile