CoreNEURON
memory_utils.h
Go to the documentation of this file.
1 /*
2 # =============================================================================
3 # Copyright (c) 2016 - 2021 Blue Brain Project/EPFL
4 #
5 # See top-level LICENSE file for details.
6 # =============================================================================.
7 */
8 
9 /**
10  * @file memory_utils.h
11  * @date 25th Oct 2014
12  * @brief Function prototypes for the functions providing
13  * information about simulator memory usage
14  *
15  */
16 
17 #pragma once
18 
19 namespace coreneuron {
20 /** @brief Reports current memory usage of the simulator to stdout
21  *
22  * Current implementation is based on mallinfo. This routine prints
23  * min, max and avg memory usage across mpi comm world
24  * @param message string indicating current stage of the simulation
25  * @param all_ranks indicate whether to print info from all ranks
26  * @return Void
27  */
28 void report_mem_usage(const char* message, bool all_ranks = false);
29 
30 /** @brief Returns current memory usage in KBs
31  * @param Void
32  * @return memory usage in KBs
33  */
34 double nrn_mallinfo(void);
35 } // namespace coreneuron
coreneuron
THIS FILE IS AUTO GENERATED DONT MODIFY IT.
Definition: corenrn_parameters.cpp:12
coreneuron::nrn_mallinfo
double nrn_mallinfo(void)
Returns current memory usage in KBs.
Definition: memory_utils.cpp:43
coreneuron::report_mem_usage
void report_mem_usage(const char *message, bool all_ranks)
Reports current memory usage of the simulator to stdout.
Definition: memory_utils.cpp:79