Stat_Internals#

Interne object of the class Statistiques containing diverse informations about counters.

How to cite this class in this doc#

:ref:`Stat\_Internals <class-stat-internals>`
[Stat\_Internals](#class-stat-internals)

Detailed description#

This is an internal object of the Statistiques class that encapsulate informations about counters. For each numerical simulation, a unique Stat_Internals is created at the start of the computation and associated with the Statistiques type object.

List of Public Methods#

Complete Member Function Documentation#

Stat_Internals
Stat_Internals::Stat_Internals()

Constructor of the class Sat_Internals that sets everything to 0.

How to cite in this doc:
:ref:`Stat_Internals::Stat_Internals() <public-stat-internals-stat-internals>`
[Stat_Internals::Stat_Internals()](#public-stat-internals-stat-internals)

Attributes Documentation#

change_level_forbidden (public)
int Stat_Internals::change_level_forbidden

If = 1, no change of level allowed, 0 otherwise.

comm_domaines_on (public)
bool Stat_Internals::comm_domaines_on[MAXCOUNTERS]
communication_tracking_info (public)
Stat_Results** Stat_Internals::communication_tracking_info
counter_comm (public)
int Stat_Internals::counter_comm[MAXCOUNTERS]

Equal to 1 if it is a communication counter, 0 otherwise.

counter_level (public)
int Stat_Internals::counter_level[MAXCOUNTERS]

Table of the counter level.

counter_nb (public)
unsigned long long Stat_Internals::counter_nb[MAXCOUNTERS]

For each counter, count the number of time it has been called.

counter_quantity (public)
unsigned long long Stat_Internals::counter_quantity[MAXCOUNTERS]

A user based quantity, which depends on the counter and is updated in the end_count function.

counter_running (public)
int Stat_Internals::counter_running[MAXCOUNTERS]

For each counter, is equal to 1 if the counter is still running, 0 otherwise.

counter_time (public)
Time Stat_Internals::counter_time[MAXCOUNTERS]

Contains the total CPU time for each counter.

counters_avg_min_max_var_per_step (public)
double Stat_Internals::counters_avg_min_max_var_per_step[MAXCOUNTERS][5]

This table contains and compute time quantities at the end of the last calculation iteration for each counter.

0: Total time passed by in each counter (without counting the last iteration) 1: Averaged time passed by for each counter on an iteration 2: Minimum time passed by for each counter on an iteration 3: Maximum time passed by for each counter on an iteration 4: Variance of the time passed by for each counter on an iteration

debug_level_before (public)
int Stat_Internals::debug_level_before

Save the debug level during the printing process.

description (public)
const char* Stat_Internals::description[MAXCOUNTERS]

Table of the counters names.

description_to_id (public)
std::map<const char*, int> Stat_Internals::description_to_id

mapping between counter description and counter id

family (public)
const char* Stat_Internals::family[MAXCOUNTERS]

Table of the counters family for which we want joined stats.

index_in_communication_tracking_info (public)
int Stat_Internals::index_in_communication_tracking_info[MAXCOUNTERS]

Table containing communication times of each wanted part of the code.

First dimension i : number of the communication counter. Use function get_counter_id_from_index_in_comm_tracking_info(i) to know the associated counter ID. Second dimension j : Time elapsed in each domain j by the communication counter i. If j = = 0, then it contains the total communication time of the communication counter i. if the counter is a communication, give its index inside the communication_tracking_info array ( - 1 otherwise)

max_debug_level_during_session (public)
int Stat_Internals::max_debug_level_during_session

Debug level which change the quantity of output in the performance log file.

nb_comm_counters (public)
int Stat_Internals::nb_comm_counters
nb_counters (public)
int Stat_Internals::nb_counters

number of counters

time_begin (public)
Time Stat_Internals::time_begin[MAXCOUNTERS]

Contains the time when each counter is firstly start.

A set of tables of the size MAX_COUNTER is created, containing the needed information for the creation of the performance file