t8_forest_profiling.h

Go to the documentation of this file.

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.
 
  Copyright (C) 2015 the developers
 
  t8code is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
 
  t8code is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest */
 
#ifndef T8_FOREST_PROFILING_H
#define T8_FOREST_PROFILING_H
 
#include <sc_statistics.h>
T8_EXTERN_C_BEGIN ();
 
void
t8_forest_set_profiling (t8_forest_t forest, int set_profiling);
 
/* TODO: document */
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);
 
double
t8_forest_profile_get_adapt_time (t8_forest_t forest);
 
double
t8_forest_profile_get_partition_time (t8_forest_t forest, int *procs_sent);
 
double
t8_forest_profile_get_balance_time (t8_forest_t forest, int *balance_rounds);
 
double
t8_forest_profile_get_ghost_time (t8_forest_t forest, t8_locidx_t *ghosts_sent);
 
double
t8_forest_profile_get_ghostexchange_waittime (t8_forest_t forest);
T8_EXTERN_C_END ();
 
#endif /* !T8_FOREST_PROFILING_H */