ergo
output.h
Go to the documentation of this file.
1 /* Ergo, version 3.8, a program for linear scaling electronic structure
2  * calculations.
3  * Copyright (C) 2019 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
4  * and Anastasia Kruchinina.
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  *
19  * Primary academic reference:
20  * Ergo: An open-source program for linear-scaling electronic structure
21  * calculations,
22  * Elias Rudberg, Emanuel H. Rubensson, Pawel Salek, and Anastasia
23  * Kruchinina,
24  * SoftwareX 7, 107 (2018),
25  * <http://dx.doi.org/10.1016/j.softx.2018.03.005>
26  *
27  * For further information about Ergo, see <http://www.ergoscf.org>.
28  */
29 
37 #ifndef OUTPUT_HEADER
38 #define OUTPUT_HEADER
39 
40 
41 #include <stdarg.h>
42 
43 
44 
45 /* Log categories */
46 #define LOG_CAT_UNDEFINED 0
47 #define LOG_CAT_ERROR 1
48 #define LOG_CAT_WARNING 2
49 #define LOG_CAT_INFO 3
50 #define LOG_CAT_EXTRAINFO 4
51 #define LOG_CAT_RESULTS 5
52 #define LOG_CAT_TIMINGS 6
53 #define LOG_CAT_MEMUSAGE 7
54 
55 /* Log areas */
56 #define LOG_AREA_UNDEFINED 0
57 #define LOG_AREA_MAIN 1
58 #define LOG_AREA_SCF 2
59 #define LOG_AREA_LR 3
60 #define LOG_AREA_INTEGRALS 4
61 #define LOG_AREA_DENSFROMF 5
62 #define LOG_AREA_DFT 6
63 #define LOG_AREA_LOWLEVEL 7
64 #define LOG_AREA_CI 8
65 #define LOG_AREA_ED 9
66 #define LOG_AREA_GS 10
67 
68 /* output functions */
69 void do_output(int logCategory, int logArea, const char* format, ...);
70 int do_voutput(int logCategory, int logArea, const char* format, va_list v);
71 int do_voutput_printf(int logCategory, int logArea, const char* format, va_list a);
72 void do_output_time(int logCategory, int logArea, const char* s);
73 void output_current_memory_usage(int logArea, const char* contextString);
75 void enable_output();
77 
78 
79 #endif
LOG_CAT_RESULTS
#define LOG_CAT_RESULTS
Definition: output.h:51
enable_output
void enable_output()
Definition: output.cc:181
LOG_CAT_TIMINGS
#define LOG_CAT_TIMINGS
Definition: output.h:52
use_printf
static int use_printf
Definition: output.cc:49
do_voutput_printf
int do_voutput_printf(int logCategory, int logArea, const char *format, va_list a)
Definition: output.cc:76
LOG_CAT_ERROR
#define LOG_CAT_ERROR
Definition: output.h:47
LOG_CAT_WARNING
#define LOG_CAT_WARNING
Definition: output.h:48
do_output_time
void do_output_time(int logCategory, int logArea, const char *s)
Definition: output.cc:159
enable_printf_output
void enable_printf_output()
Definition: output.cc:66
LOG_CAT_MEMUSAGE
#define LOG_CAT_MEMUSAGE
Definition: output.h:53
enable_printf_output
void enable_printf_output()
Definition: output.cc:66
LOG_AREA_LR
#define LOG_AREA_LR
Definition: output.h:59
LOG_AREA_GS
#define LOG_AREA_GS
Definition: output.h:66
global_memory_usage_output_flag
static int global_memory_usage_output_flag
Definition: output.cc:44
LOG_AREA_DENSFROMF
#define LOG_AREA_DENSFROMF
Definition: output.h:61
global_output_enabled_flag
static int global_output_enabled_flag
Definition: output.cc:47
enable_output
void enable_output()
Definition: output.cc:181
LOG_AREA_LOWLEVEL
#define LOG_AREA_LOWLEVEL
Definition: output.h:63
get_memory_usage_by_procfile
int get_memory_usage_by_procfile(double *virtualMemGigaBytes, double *residentMemGigaBytes, double *virtualMemPeakGigaBytes)
Definition: utilities.cc:229
LOG_CAT_EXTRAINFO
#define LOG_CAT_EXTRAINFO
Definition: output.h:50
enable_memory_usage_output
void enable_memory_usage_output(void)
Definition: output.cc:175
do_voutput
int do_voutput(int logCategory, int logArea, const char *format, va_list a)
Definition: output.cc:94
LOG_AREA_UNDEFINED
#define LOG_AREA_UNDEFINED
Definition: output.h:56
LOG_AREA_ED
#define LOG_AREA_ED
Definition: output.h:65
do_voutput_printf
int do_voutput_printf(int logCategory, int logArea, const char *format, va_list a)
Definition: output.cc:76
utilities.h
Basic OS access utilities.
LOG_CAT_INFO
#define LOG_CAT_INFO
Definition: output.h:49
LOG_AREA_MAIN
#define LOG_AREA_MAIN
Definition: output.h:57
output_current_memory_usage
void output_current_memory_usage(int logArea, const char *contextString)
Definition: output.cc:186
LOG_AREA_SCF
#define LOG_AREA_SCF
Definition: output.h:58
LOG_AREA_INTEGRALS
#define LOG_AREA_INTEGRALS
Definition: output.h:60
do_output_time
void do_output_time(int logCategory, int logArea, const char *s)
Definition: output.cc:159
output_current_memory_usage
void output_current_memory_usage(int logArea, const char *contextString)
Definition: output.cc:186
enable_memory_usage_output
void enable_memory_usage_output()
Definition: output.cc:175
do_output
void do_output(int logCategory, int logArea, const char *format,...)
Definition: output.cc:53
do_output
void do_output(int logCategory, int logArea, const char *format,...)
Definition: output.cc:53
do_voutput
int do_voutput(int logCategory, int logArea, const char *format, va_list v)
Definition: output.cc:94
LOG_AREA_DFT
#define LOG_AREA_DFT
Definition: output.h:62
output.h
Functionality for writing output messages to a text file.
LOG_AREA_CI
#define LOG_AREA_CI
Definition: output.h:64
LOG_CAT_UNDEFINED
#define LOG_CAT_UNDEFINED
Definition: output.h:46