Perf_counters::Impl

Brief description

How to reference this class

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`Perf\_counters::Impl <class-perf-counters-impl>`

Markdown

[Perf\_counters::Impl](#class-perf-counters-impl)

Detailed description

Brief declare all standard counters of TRUST inside an array

Member Functions: Public

• add_to_gpu_timer_counter_impl

• begin_count_impl

• begin_count_impl

• compute_gpu_time_impl

• create_custom_counter_impl

• end_count_impl

• end_count_impl

• end_time_step_impl

• end_timeloop_impl

• get_computation_time_impl

• get_gpu_fence_impl

• get_gpu_timer_counter_impl

• get_gpu_timer_impl

• get_init_device_impl

• get_last_opened_counter_level_impl

• get_time_since_last_open_impl

• get_time_since_last_open_impl

• get_total_time_impl

• get_total_time_impl

• get_use_gpu_impl

• Impl

• is_gpu_verbose_on_impl

• now

• print_TU_files_impl

• reset_counters_impl

• restart_counters_impl

• running_impl

• set_gpu_fence_impl

• set_gpu_verbose_impl

• set_init_device_impl

• set_time_steps_elapsed_impl

• start_gpu_timer_impl

• start_time_step_impl

• start_timeloop_impl

• stop_counters_impl

• stop_gpu_timer_impl

• ~Impl

Member Functions: Private

• check_begin

• check_end

• compute_allreduce_peak

• get_counter

• get_counter

• get_cpu

• get_date

• get_gpu

• get_os

• print_global_TU

• print_performance_to_csv

Complete Member Function Documentation

add_to_gpu_timer_counter_impl

Definition

void Perf_counters::Impl::add_to_gpu_timer_counter_impl(int to_add=1)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::add_to_gpu_timer_counter_impl(int to_add=1) <perf-counters-impl-public-void-perf-counters-impl-add-to-gpu-timer-counter-impl-int-to-add-equal-1>`

Markdown

[void Perf_counters::Impl::add_to_gpu_timer_counter_impl(int to_add=1)](#perf-counters-impl-public-void-perf-counters-impl-add-to-gpu-timer-counter-impl-int-to-add-equal-1)

begin_count_impl

Definition

void Perf_counters::Impl::begin_count_impl(const std::string &custom_count_name, int counter_lvl)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::begin_count_impl(const std::string &custom_count_name, int counter_lvl) <perf-counters-impl-public-void-perf-counters-impl-begin-count-impl-const-std-string-ref-custom-count-name-int-counter-lvl>`

Markdown

[void Perf_counters::Impl::begin_count_impl(const std::string &custom_count_name, int counter_lvl)](#perf-counters-impl-public-void-perf-counters-impl-begin-count-impl-const-std-string-ref-custom-count-name-int-counter-lvl)

begin_count_impl

Definition

void Perf_counters::Impl::begin_count_impl(const STD_COUNTERS &std_cnt, int counter_lvl)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::begin_count_impl(const STD_COUNTERS &std_cnt, int counter_lvl) <perf-counters-impl-public-void-perf-counters-impl-begin-count-impl-const-std-counters-ref-std-cnt-int-counter-lvl>`

Markdown

[void Perf_counters::Impl::begin_count_impl(const STD_COUNTERS &std_cnt, int counter_lvl)](#perf-counters-impl-public-void-perf-counters-impl-begin-count-impl-const-std-counters-ref-std-cnt-int-counter-lvl)

compute_gpu_time_impl

Definition

double Perf_counters::Impl::compute_gpu_time_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::compute_gpu_time_impl() <perf-counters-impl-public-double-perf-counters-impl-compute-gpu-time-impl>`

Markdown

[double Perf_counters::Impl::compute_gpu_time_impl()](#perf-counters-impl-public-double-perf-counters-impl-compute-gpu-time-impl)

create_custom_counter_impl

Definition

void Perf_counters::Impl::create_custom_counter_impl(std::string counter_description, int counter_level, std::string counter_family, bool is_comm, bool is_gpu)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::create_custom_counter_impl(std::string counter_description, int counter_level, std::string counter_family, bool is_comm, bool is_gpu) <perf-counters-impl-public-void-perf-counters-impl-create-custom-counter-impl-std-string-counter-description-int-counter-level-std-string-counter-family-bool-is-comm-bool-is-gpu>`

Markdown

[void Perf_counters::Impl::create_custom_counter_impl(std::string counter_description, int counter_level, std::string counter_family, bool is_comm, bool is_gpu)](#perf-counters-impl-public-void-perf-counters-impl-create-custom-counter-impl-std-string-counter-description-int-counter-level-std-string-counter-family-bool-is-comm-bool-is-gpu)

end_count_impl

Definition

void Perf_counters::Impl::end_count_impl(const std::string &custom_count_name, int count_increment, long int quantity_increment)

Brief description

End the count of a counter and update the counter values.

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::end_count_impl(const std::string &custom_count_name, int count_increment, long int quantity_increment) <perf-counters-impl-public-void-perf-counters-impl-end-count-impl-const-std-string-ref-custom-count-name-int-count-increment-long-int-quantity-increment>`

Markdown

[void Perf_counters::Impl::end_count_impl(const std::string &custom_count_name, int count_increment, long int quantity_increment)](#perf-counters-impl-public-void-perf-counters-impl-end-count-impl-const-std-string-ref-custom-count-name-int-count-increment-long-int-quantity-increment)

end_count_impl

Definition

void Perf_counters::Impl::end_count_impl(const STD_COUNTERS &std_cnt, int count_increment, long int quantity_increment)

Brief description

End the count of a counter and update the counter values.

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::end_count_impl(const STD_COUNTERS &std_cnt, int count_increment, long int quantity_increment) <perf-counters-impl-public-void-perf-counters-impl-end-count-impl-const-std-counters-ref-std-cnt-int-count-increment-long-int-quantity-increment>`

Markdown

[void Perf_counters::Impl::end_count_impl(const STD_COUNTERS &std_cnt, int count_increment, long int quantity_increment)](#perf-counters-impl-public-void-perf-counters-impl-end-count-impl-const-std-counters-ref-std-cnt-int-count-increment-long-int-quantity-increment)

end_time_step_impl

Definition

void Perf_counters::Impl::end_time_step_impl(long int tstep)

Brief description

Compute for each counter open during a time step avg_time_per_step_, min_time_per_step_, max_time_per_step_ and sd_time_per_step_.

Detailed description

Called at the end of each time step, and only then Nota : if the counter is called before the time step loop, it is not accounted for in the computation.

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::end_time_step_impl(long int tstep) <perf-counters-impl-public-void-perf-counters-impl-end-time-step-impl-long-int-tstep>`

Markdown

[void Perf_counters::Impl::end_time_step_impl(long int tstep)](#perf-counters-impl-public-void-perf-counters-impl-end-time-step-impl-long-int-tstep)

end_timeloop_impl

Definition

void Perf_counters::Impl::end_timeloop_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::end_timeloop_impl() <perf-counters-impl-public-void-perf-counters-impl-end-timeloop-impl>`

Markdown

[void Perf_counters::Impl::end_timeloop_impl()](#perf-counters-impl-public-void-perf-counters-impl-end-timeloop-impl)

get_computation_time_impl

Definition

double Perf_counters::Impl::get_computation_time_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::get_computation_time_impl() <perf-counters-impl-public-double-perf-counters-impl-get-computation-time-impl>`

Markdown

[double Perf_counters::Impl::get_computation_time_impl()](#perf-counters-impl-public-double-perf-counters-impl-get-computation-time-impl)

get_gpu_fence_impl

Definition

bool Perf_counters::Impl::get_gpu_fence_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`bool Perf_counters::Impl::get_gpu_fence_impl() const <perf-counters-impl-public-bool-perf-counters-impl-get-gpu-fence-impl-const>`

Markdown

[bool Perf_counters::Impl::get_gpu_fence_impl() const](#perf-counters-impl-public-bool-perf-counters-impl-get-gpu-fence-impl-const)

get_gpu_timer_counter_impl

Definition

int Perf_counters::Impl::get_gpu_timer_counter_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`int Perf_counters::Impl::get_gpu_timer_counter_impl() const <perf-counters-impl-public-int-perf-counters-impl-get-gpu-timer-counter-impl-const>`

Markdown

[int Perf_counters::Impl::get_gpu_timer_counter_impl() const](#perf-counters-impl-public-int-perf-counters-impl-get-gpu-timer-counter-impl-const)

get_gpu_timer_impl

Definition

bool Perf_counters::Impl::get_gpu_timer_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`bool Perf_counters::Impl::get_gpu_timer_impl() const <perf-counters-impl-public-bool-perf-counters-impl-get-gpu-timer-impl-const>`

Markdown

[bool Perf_counters::Impl::get_gpu_timer_impl() const](#perf-counters-impl-public-bool-perf-counters-impl-get-gpu-timer-impl-const)

get_init_device_impl

Definition

bool Perf_counters::Impl::get_init_device_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`bool Perf_counters::Impl::get_init_device_impl() const <perf-counters-impl-public-bool-perf-counters-impl-get-init-device-impl-const>`

Markdown

[bool Perf_counters::Impl::get_init_device_impl() const](#perf-counters-impl-public-bool-perf-counters-impl-get-init-device-impl-const)

get_last_opened_counter_level_impl

Definition

int Perf_counters::Impl::get_last_opened_counter_level_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`int Perf_counters::Impl::get_last_opened_counter_level_impl() const <perf-counters-impl-public-int-perf-counters-impl-get-last-opened-counter-level-impl-const>`

Markdown

[int Perf_counters::Impl::get_last_opened_counter_level_impl() const](#perf-counters-impl-public-int-perf-counters-impl-get-last-opened-counter-level-impl-const)

get_time_since_last_open_impl

Definition

double Perf_counters::Impl::get_time_since_last_open_impl(const std::string &name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::get_time_since_last_open_impl(const std::string &name) <perf-counters-impl-public-double-perf-counters-impl-get-time-since-last-open-impl-const-std-string-ref-name>`

Markdown

[double Perf_counters::Impl::get_time_since_last_open_impl(const std::string &name)](#perf-counters-impl-public-double-perf-counters-impl-get-time-since-last-open-impl-const-std-string-ref-name)

get_time_since_last_open_impl

Definition

double Perf_counters::Impl::get_time_since_last_open_impl(const STD_COUNTERS &name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::get_time_since_last_open_impl(const STD_COUNTERS &name) <perf-counters-impl-public-double-perf-counters-impl-get-time-since-last-open-impl-const-std-counters-ref-name>`

Markdown

[double Perf_counters::Impl::get_time_since_last_open_impl(const STD_COUNTERS &name)](#perf-counters-impl-public-double-perf-counters-impl-get-time-since-last-open-impl-const-std-counters-ref-name)

get_total_time_impl

Definition

double Perf_counters::Impl::get_total_time_impl(const std::string &name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::get_total_time_impl(const std::string &name) <perf-counters-impl-public-double-perf-counters-impl-get-total-time-impl-const-std-string-ref-name>`

Markdown

[double Perf_counters::Impl::get_total_time_impl(const std::string &name)](#perf-counters-impl-public-double-perf-counters-impl-get-total-time-impl-const-std-string-ref-name)

get_total_time_impl

Definition

double Perf_counters::Impl::get_total_time_impl(const STD_COUNTERS &name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::get_total_time_impl(const STD_COUNTERS &name) <perf-counters-impl-public-double-perf-counters-impl-get-total-time-impl-const-std-counters-ref-name>`

Markdown

[double Perf_counters::Impl::get_total_time_impl(const STD_COUNTERS &name)](#perf-counters-impl-public-double-perf-counters-impl-get-total-time-impl-const-std-counters-ref-name)

get_use_gpu_impl

Definition

bool Perf_counters::Impl::get_use_gpu_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`bool Perf_counters::Impl::get_use_gpu_impl() const <perf-counters-impl-public-bool-perf-counters-impl-get-use-gpu-impl-const>`

Markdown

[bool Perf_counters::Impl::get_use_gpu_impl() const](#perf-counters-impl-public-bool-perf-counters-impl-get-use-gpu-impl-const)

Impl

Definition

Perf_counters::Impl::Impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`Perf_counters::Impl::Impl() <perf-counters-impl-public-perf-counters-impl-impl>`

Markdown

[Perf_counters::Impl::Impl()](#perf-counters-impl-public-perf-counters-impl-impl)

is_gpu_verbose_on_impl

Definition

bool Perf_counters::Impl::is_gpu_verbose_on_impl() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`bool Perf_counters::Impl::is_gpu_verbose_on_impl() const <perf-counters-impl-public-bool-perf-counters-impl-is-gpu-verbose-on-impl-const>`

Markdown

[bool Perf_counters::Impl::is_gpu_verbose_on_impl() const](#perf-counters-impl-public-bool-perf-counters-impl-is-gpu-verbose-on-impl-const)

now

Definition

time_point Perf_counters::Impl::now()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`time_point Perf_counters::Impl::now() <perf-counters-impl-public-time-point-perf-counters-impl-now>`

Markdown

[time_point Perf_counters::Impl::now()](#perf-counters-impl-public-time-point-perf-counters-impl-now)

print_TU_files_impl

Definition

void Perf_counters::Impl::print_TU_files_impl(const std::string &message)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::print_TU_files_impl(const std::string &message) <perf-counters-impl-public-void-perf-counters-impl-print-tu-files-impl-const-std-string-ref-message>`

Markdown

[void Perf_counters::Impl::print_TU_files_impl(const std::string &message)](#perf-counters-impl-public-void-perf-counters-impl-print-tu-files-impl-const-std-string-ref-message)

reset_counters_impl

Definition

void Perf_counters::Impl::reset_counters_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::reset_counters_impl() <perf-counters-impl-public-void-perf-counters-impl-reset-counters-impl>`

Markdown

[void Perf_counters::Impl::reset_counters_impl()](#perf-counters-impl-public-void-perf-counters-impl-reset-counters-impl)

restart_counters_impl

Definition

void Perf_counters::Impl::restart_counters_impl()

Brief description

Restart all counters, has to be called on every processor simultaneously.

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::restart_counters_impl() <perf-counters-impl-public-void-perf-counters-impl-restart-counters-impl>`

Markdown

[void Perf_counters::Impl::restart_counters_impl()](#perf-counters-impl-public-void-perf-counters-impl-restart-counters-impl)

running_impl

Definition

bool Perf_counters::Impl::running_impl(const STD_COUNTERS name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`bool Perf_counters::Impl::running_impl(const STD_COUNTERS name) <perf-counters-impl-public-bool-perf-counters-impl-running-impl-const-std-counters-name>`

Markdown

[bool Perf_counters::Impl::running_impl(const STD_COUNTERS name)](#perf-counters-impl-public-bool-perf-counters-impl-running-impl-const-std-counters-name)

set_gpu_fence_impl

Definition

void Perf_counters::Impl::set_gpu_fence_impl(bool fence)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::set_gpu_fence_impl(bool fence) <perf-counters-impl-public-void-perf-counters-impl-set-gpu-fence-impl-bool-fence>`

Markdown

[void Perf_counters::Impl::set_gpu_fence_impl(bool fence)](#perf-counters-impl-public-void-perf-counters-impl-set-gpu-fence-impl-bool-fence)

set_gpu_verbose_impl

Definition

void Perf_counters::Impl::set_gpu_verbose_impl(bool on)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::set_gpu_verbose_impl(bool on) <perf-counters-impl-public-void-perf-counters-impl-set-gpu-verbose-impl-bool-on>`

Markdown

[void Perf_counters::Impl::set_gpu_verbose_impl(bool on)](#perf-counters-impl-public-void-perf-counters-impl-set-gpu-verbose-impl-bool-on)

set_init_device_impl

Definition

void Perf_counters::Impl::set_init_device_impl(bool init)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::set_init_device_impl(bool init) <perf-counters-impl-public-void-perf-counters-impl-set-init-device-impl-bool-init>`

Markdown

[void Perf_counters::Impl::set_init_device_impl(bool init)](#perf-counters-impl-public-void-perf-counters-impl-set-init-device-impl-bool-init)

set_time_steps_elapsed_impl

Definition

void Perf_counters::Impl::set_time_steps_elapsed_impl(int time_step_elapsed)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::set_time_steps_elapsed_impl(int time_step_elapsed) <perf-counters-impl-public-void-perf-counters-impl-set-time-steps-elapsed-impl-int-time-step-elapsed>`

Markdown

[void Perf_counters::Impl::set_time_steps_elapsed_impl(int time_step_elapsed)](#perf-counters-impl-public-void-perf-counters-impl-set-time-steps-elapsed-impl-int-time-step-elapsed)

start_gpu_timer_impl

Definition

void Perf_counters::Impl::start_gpu_timer_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::start_gpu_timer_impl() <perf-counters-impl-public-void-perf-counters-impl-start-gpu-timer-impl>`

Markdown

[void Perf_counters::Impl::start_gpu_timer_impl()](#perf-counters-impl-public-void-perf-counters-impl-start-gpu-timer-impl)

start_time_step_impl

Definition

void Perf_counters::Impl::start_time_step_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::start_time_step_impl() <perf-counters-impl-public-void-perf-counters-impl-start-time-step-impl>`

Markdown

[void Perf_counters::Impl::start_time_step_impl()](#perf-counters-impl-public-void-perf-counters-impl-start-time-step-impl)

start_timeloop_impl

Definition

void Perf_counters::Impl::start_timeloop_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::start_timeloop_impl() <perf-counters-impl-public-void-perf-counters-impl-start-timeloop-impl>`

Markdown

[void Perf_counters::Impl::start_timeloop_impl()](#perf-counters-impl-public-void-perf-counters-impl-start-timeloop-impl)

stop_counters_impl

Definition

void Perf_counters::Impl::stop_counters_impl()

Brief description

Stop all counters, has to be called on every processor simultaneously.

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::stop_counters_impl() <perf-counters-impl-public-void-perf-counters-impl-stop-counters-impl>`

Markdown

[void Perf_counters::Impl::stop_counters_impl()](#perf-counters-impl-public-void-perf-counters-impl-stop-counters-impl)

stop_gpu_timer_impl

Definition

void Perf_counters::Impl::stop_gpu_timer_impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::stop_gpu_timer_impl() <perf-counters-impl-public-void-perf-counters-impl-stop-gpu-timer-impl>`

Markdown

[void Perf_counters::Impl::stop_gpu_timer_impl()](#perf-counters-impl-public-void-perf-counters-impl-stop-gpu-timer-impl)

~Impl

Definition

Perf_counters::Impl::~Impl()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`Perf_counters::Impl::~Impl() <perf-counters-impl-public-perf-counters-impl-dtor-impl>`

Markdown

[Perf_counters::Impl::~Impl()](#perf-counters-impl-public-perf-counters-impl-dtor-impl)

check_begin

Definition

void Perf_counters::Impl::check_begin(Counter &c, int counter_lvl, time_point t)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::check_begin(Counter &c, int counter_lvl, time_point t) <perf-counters-impl-private-void-perf-counters-impl-check-begin-counter-ref-c-int-counter-lvl-time-point-t>`

Markdown

[void Perf_counters::Impl::check_begin(Counter &c, int counter_lvl, time_point t)](#perf-counters-impl-private-void-perf-counters-impl-check-begin-counter-ref-c-int-counter-lvl-time-point-t)

check_end

Definition

void Perf_counters::Impl::check_end(Counter &c, time_point t)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::check_end(Counter &c, time_point t) <perf-counters-impl-private-void-perf-counters-impl-check-end-counter-ref-c-time-point-t>`

Markdown

[void Perf_counters::Impl::check_end(Counter &c, time_point t)](#perf-counters-impl-private-void-perf-counters-impl-check-end-counter-ref-c-time-point-t)

compute_allreduce_peak

Definition

double Perf_counters::Impl::compute_allreduce_peak()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`double Perf_counters::Impl::compute_allreduce_peak() <perf-counters-impl-private-double-perf-counters-impl-compute-allreduce-peak>`

Markdown

[double Perf_counters::Impl::compute_allreduce_peak()](#perf-counters-impl-private-double-perf-counters-impl-compute-allreduce-peak)

get_counter

Definition

Counter & Perf_counters::Impl::get_counter(const std::string name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`Counter & Perf_counters::Impl::get_counter(const std::string name) <perf-counters-impl-private-counter-ref-perf-counters-impl-get-counter-const-std-string-name>`

Markdown

[Counter & Perf_counters::Impl::get_counter(const std::string name)](#perf-counters-impl-private-counter-ref-perf-counters-impl-get-counter-const-std-string-name)

get_counter

Definition

Counter & Perf_counters::Impl::get_counter(const STD_COUNTERS name)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`Counter & Perf_counters::Impl::get_counter(const STD_COUNTERS name) <perf-counters-impl-private-counter-ref-perf-counters-impl-get-counter-const-std-counters-name>`

Markdown

[Counter & Perf_counters::Impl::get_counter(const STD_COUNTERS name)](#perf-counters-impl-private-counter-ref-perf-counters-impl-get-counter-const-std-counters-name)

get_cpu

Definition

std::string Perf_counters::Impl::get_cpu() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`std::string Perf_counters::Impl::get_cpu() const <perf-counters-impl-private-std-string-perf-counters-impl-get-cpu-const>`

Markdown

[std::string Perf_counters::Impl::get_cpu() const](#perf-counters-impl-private-std-string-perf-counters-impl-get-cpu-const)

get_date

Definition

std::string Perf_counters::Impl::get_date() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`std::string Perf_counters::Impl::get_date() const <perf-counters-impl-private-std-string-perf-counters-impl-get-date-const>`

Markdown

[std::string Perf_counters::Impl::get_date() const](#perf-counters-impl-private-std-string-perf-counters-impl-get-date-const)

get_gpu

Definition

std::string Perf_counters::Impl::get_gpu() const

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`std::string Perf_counters::Impl::get_gpu() const <perf-counters-impl-private-std-string-perf-counters-impl-get-gpu-const>`

Markdown

[std::string Perf_counters::Impl::get_gpu() const](#perf-counters-impl-private-std-string-perf-counters-impl-get-gpu-const)

get_os

Definition

std::string Perf_counters::Impl::get_os() const

Brief description

Return a string that contains os information.

Detailed description

for example: node name = is247793 system name = Linux machine = x86_64 release = 6.5.0 - 44 - generic version = #44~22.04.1 - Ubuntu SMP PREEMPT_DYNAMIC + current date and time

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`std::string Perf_counters::Impl::get_os() const <perf-counters-impl-private-std-string-perf-counters-impl-get-os-const>`

Markdown

[std::string Perf_counters::Impl::get_os() const](#perf-counters-impl-private-std-string-perf-counters-impl-get-os-const)

print_global_TU

Definition

void Perf_counters::Impl::print_global_TU(const std::string &message)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::print_global_TU(const std::string &message) <perf-counters-impl-private-void-perf-counters-impl-print-global-tu-const-std-string-ref-message>`

Markdown

[void Perf_counters::Impl::print_global_TU(const std::string &message)](#perf-counters-impl-private-void-perf-counters-impl-print-global-tu-const-std-string-ref-message)

print_performance_to_csv

Definition

void Perf_counters::Impl::print_performance_to_csv(const std::string &message)

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`void Perf_counters::Impl::print_performance_to_csv(const std::string &message) <perf-counters-impl-private-void-perf-counters-impl-print-performance-to-csv-const-std-string-ref-message>`

Markdown

[void Perf_counters::Impl::print_performance_to_csv(const std::string &message)](#perf-counters-impl-private-void-perf-counters-impl-print-performance-to-csv-const-std-string-ref-message)

Attributes Documentation

computation_time_ (private)

duration Perf_counters::Impl::computation_time_ = duration::zero()

Used to compute the total time of the simulation.

counters_stop_ (private)

bool Perf_counters::Impl::counters_stop_ = false

A flag used to know if the counters are paused or not.

custom_counter_map_str_to_counter_ (private)

std::map<std::string, std::unique_ptr<Counter>> Perf_counters::Impl::custom_counter_map_str_to_counter_

Store custom counters using unique_ptr.

end_cache_ (private)

bool Perf_counters::Impl::end_cache_ = false

A flag used to know if the two first time steps are over or not.

gpu_fence_ (private)

bool Perf_counters::Impl::gpu_fence_ = true

gpu_timer_ (private)

bool Perf_counters::Impl::gpu_timer_ = false

gpu_timer_count_ (private)

int Perf_counters::Impl::gpu_timer_count_ = 0

gpu_timer_start_ (private)

time_point Perf_counters::Impl::gpu_timer_start_

gpu_verbose_ (private)

bool Perf_counters::Impl::gpu_verbose_ = false

init_device_ (private)

bool Perf_counters::Impl::init_device_ = false

last_opened_counter_ (private)

Counter* Perf_counters::Impl::last_opened_counter_ = nullptr

pointer to the last opened counter. Each counter has a parent attribute, which also give the pointer of the counter open before them.

max_str_length_ (private)

int Perf_counters::Impl::max_str_length_ = 118

nb_steps_elapsed_ (private)

int Perf_counters::Impl::nb_steps_elapsed_ = 0

By default, we consider that the two first time steps are used to file the cache, so they are not taken into account in the stats.

std_counters_ (private)

std::array<std::unique_ptr<Counter>, static_cast<int>(STD_COUNTERS::NB_OF_STD_COUNTER)> Perf_counters::Impl::std_counters_

Store standard counters using unique_ptr.

time_loop_ (private)

bool Perf_counters::Impl::time_loop_ = false

A flag used to know if we are inside the time loop.

time_skipped_ts_ (private)

duration Perf_counters::Impl::time_skipped_ts_ = duration::zero()

the duration in seconds of the cache. If cache is too long, use function set_three_first_steps_elapsed in oder to include the stats of the cache in your stats

total_data_exchange_per_backup_ (private)

double Perf_counters::Impl::total_data_exchange_per_backup_ = 0.

total_nb_backup_ (private)

int Perf_counters::Impl::total_nb_backup_ = 0

use_gpu_ (private)

bool Perf_counters::Impl::use_gpu_ = false