ergo
puri_info.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 
42 #ifndef PURI_INFO_HEADER
43 #define PURI_INFO_HEADER
44 
45 #include "output.h"
46 #include "matrix_typedefs.h" // definitions of matrix types and interval type
47 #include "realtype.h" // definitions of types
48 
49 //#define CHECK_IF_STOPPED_TOO_LATE_OR_TOO_EARLY
50 
51 
53  public:
54  typedef ergo_real real;
55 
56  int it; //iteration number
58  double Xsquare_time;
59  double trunc_time;
60  double purify_time;
61  double total_time;
64  double trace_diff_time ;
67  double nnz_time;
68  double inf_diff_time;
81  int poly;
82  real gap; // estimated gap
85  // bounds for homo and lumo during iterations
86  // [lumo_low, lumo_upp] and [1-homo_upp, 1-homo_low]
91 
93 
94  real alpha; // for SP2 accelerated
95 
97 
98 
100  it(-1),
101  threshold_X(0),
102  Xsquare_time(0),
103  trunc_time(0),
104  purify_time(0),
105  total_time(0),
107  eucl_diff_time(0),
108  trace_diff_time(0),
109  mixed_diff_time(0),
110  frob_diff_time(0),
111  nnz_time(0),
112  inf_diff_time(0),
119  XmX2_trace(-1),
120  XmX2_fro_norm(-1),
121  XmX2_mixed_norm(-1),
122  XmX2_eucl(-1),
123  order(0),
124  poly(-1),
125  gap(-1),
126  NNZ_X(0),
127  NNZ_X2(0),
128  homo_bound_low(0),
129  homo_bound_upp(0),
130  lumo_bound_low(0),
131  lumo_bound_upp(0),
133  alpha(0),
134  constantC(0)
135  {};
136 
137 
138 };
139 
140 
141 class PuriInfo{
142  public:
143  typedef ergo_real real;
144 
146  method(0),
148  total_it(0),
149  converged(0),
150  error_subspace(0),
162  debug_output(0)
163  {};
164 
165 
166  void print_collected_info();
168 
179 
180  void get_poly_seq(std::vector<int> &norms);
181  void get_vec_frob_norms(std::vector<real> &norms);
182  void get_vec_infty_norms(std::vector<real> &norms);
183  void get_vec_mixed_norms(std::vector<real> &norms);
184  void get_vec_traces(std::vector<real> & traces);
185 
186  void get_spectrum_bounds(real &lower_spectrum_bound_, real &upper_spectrum_bound_) const;
187  void set_spectrum_bounds(const real lower_spectrum_bound_, const real upper_spectrum_bound_);
188 
189  int method; // 1 for SP2, 2 for SP2 accelerated
190 
191  int stopping_criterion; // 1 if new, 0 if not
194  int total_it;
198 
199  int converged; // 1 if converged, 0 otherwise
200 
201  real error_subspace; // expected maximum error in subspace
202  real accumulated_error_subspace; // accumulated error in subspace
203 
205 
210 
222 
223  std::vector<IterationInfo> Iterations;
225 
228 
229 };
230 
231 #endif
PuriInfo::homo_estim_low_F
real homo_estim_low_F
Definition: puri_info.h:207
IterationInfo::lumo_bound_low
real lumo_bound_low
Definition: puri_info.h:89
IterationInfo::homo_bound_upp
real homo_bound_upp
Definition: puri_info.h:88
PuriInfo::norm_F_Fprev
real norm_F_Fprev
Definition: puri_info.h:192
PuriInfo::homo_eigensolver_time
double homo_eigensolver_time
Definition: puri_info.h:218
IterationInfo::orbital_lumo_time
double orbital_lumo_time
Definition: puri_info.h:70
realtype.h
Definition of the main floating-point datatype used; the ergo_real type.
PuriInfo::get_total_purify_time
real get_total_purify_time()
Definition: puri_info.cc:118
PuriInfo::get_total_Xsquare_time
real get_total_Xsquare_time()
Definition: puri_info.cc:48
PuriInfo::get_spectrum_bounds
void get_spectrum_bounds(real &lower_spectrum_bound_, real &upper_spectrum_bound_) const
Definition: puri_info.cc:175
PuriInfo::eigValLUMO
real eigValLUMO
Definition: puri_info.h:221
PuriInfo::total_time
real total_time
Definition: puri_info.h:193
PuriInfo
Definition: puri_info.h:141
PuriInfo::method
int method
Definition: puri_info.h:189
ergo_real
double ergo_real
Definition: realtype.h:69
PuriInfo::lumo_eigensolver_time
double lumo_eigensolver_time
Definition: puri_info.h:219
PuriInfo::get_vec_frob_norms
void get_vec_frob_norms(std::vector< real > &norms)
Definition: puri_info.cc:137
PuriInfo::upper_spectrum_bound
real upper_spectrum_bound
Definition: puri_info.h:226
IterationInfo::inf_diff_time
double inf_diff_time
Definition: puri_info.h:68
PuriInfo::get_poly_seq
void get_poly_seq(std::vector< int > &norms)
Definition: puri_info.cc:128
PuriInfo::total_it
int total_it
Definition: puri_info.h:194
IterationInfo::orbital_homo_time
double orbital_homo_time
Definition: puri_info.h:69
real
ergo_real real
Definition: test.cc:46
PuriInfo::get_total_frob_diff_time
real get_total_frob_diff_time()
Definition: puri_info.cc:94
PuriInfo::print_collected_info
void print_collected_info()
Definition: puri_info.cc:187
IterationInfo::threshold_X
real threshold_X
Definition: puri_info.h:57
IterationInfo::alpha
real alpha
Definition: puri_info.h:94
IterationInfo::mixed_diff_time
double mixed_diff_time
Definition: puri_info.h:65
IterationInfo::DX_mult_lumo_time
double DX_mult_lumo_time
Definition: puri_info.h:72
IterationInfo::homo_bound_low
real homo_bound_low
Definition: puri_info.h:87
PuriInfo::real
ergo_real real
Definition: puri_info.h:143
IterationInfo::DX_mult_homo_time
double DX_mult_homo_time
Definition: puri_info.h:71
IterationInfo::NNZ_X
real NNZ_X
Definition: puri_info.h:83
PuriInfo::print_collected_info_printf
void print_collected_info_printf()
Definition: puri_info.cc:269
IterationInfo::poly
int poly
Definition: puri_info.h:81
LOG_AREA_DENSFROMF
#define LOG_AREA_DENSFROMF
Definition: output.h:61
PuriInfo::get_total_stopping_criterion_time
real get_total_stopping_criterion_time()
Definition: puri_info.cc:102
PuriInfo::estim_total_it
int estim_total_it
Definition: puri_info.h:196
PuriInfo::lumo_estim_low_F
real lumo_estim_low_F
Definition: puri_info.h:209
PuriInfo::homo_eigensolver_iter
int homo_eigensolver_iter
Definition: puri_info.h:216
PuriInfo::lower_spectrum_bound
real lower_spectrum_bound
Definition: puri_info.h:227
IterationInfo
Definition: puri_info.h:52
real
PuriInfo::real real
Definition: puri_info.cc:45
PuriInfo::additional_iterations
int additional_iterations
Definition: puri_info.h:197
PuriInfo::converged
int converged
Definition: puri_info.h:199
PuriInfo::error_subspace
real error_subspace
Definition: puri_info.h:201
IterationInfo::frob_diff_time
double frob_diff_time
Definition: puri_info.h:66
IterationInfo::Xsquare_time
double Xsquare_time
Definition: puri_info.h:58
IterationInfo::real
ergo_real real
Definition: puri_info.h:54
PuriInfo::homo_eigenvector_is_computed_in_iter
int homo_eigenvector_is_computed_in_iter
Definition: puri_info.h:214
IterationInfo::total_time
double total_time
Definition: puri_info.h:61
IterationInfo::IterationInfo
IterationInfo()
Definition: puri_info.h:99
PuriInfo::get_total_Xtrunc_time
real get_total_Xtrunc_time()
Definition: puri_info.cc:56
IterationInfo::purify_time
double purify_time
Definition: puri_info.h:60
PuriInfo::Iterations
std::vector< IterationInfo > Iterations
Definition: puri_info.h:223
PuriInfo::get_vec_traces
void get_vec_traces(std::vector< real > &traces)
Definition: puri_info.cc:165
LOG_CAT_INFO
#define LOG_CAT_INFO
Definition: output.h:49
matrix_typedefs.h
Header file with typedefs for matrix and vector types. The levels of hierarchic matrices are defined ...
PuriInfo::eigValHOMO
real eigValHOMO
Definition: puri_info.h:220
PuriInfo::stopping_criterion
int stopping_criterion
Definition: puri_info.h:191
IterationInfo::XmX2_eucl
real XmX2_eucl
Definition: puri_info.h:79
IterationInfo::eucl_diff_time
double eucl_diff_time
Definition: puri_info.h:63
PuriInfo::lumo_estim_upp_F
real lumo_estim_upp_F
Definition: puri_info.h:208
IterationInfo::it
int it
Definition: puri_info.h:56
IterationInfo::XmX2_infty_norm
real XmX2_infty_norm
Definition: puri_info.h:77
IterationInfo::order
real order
Definition: puri_info.h:80
PuriInfo::homo_eigenvector_is_computed
bool homo_eigenvector_is_computed
Definition: puri_info.h:212
PuriInfo::lumo_eigenvector_is_computed_in_iter
int lumo_eigenvector_is_computed_in_iter
Definition: puri_info.h:215
IterationInfo::lumo_bound_upp
real lumo_bound_upp
Definition: puri_info.h:90
PuriInfo::lumo_eigenvector_is_computed
bool lumo_eigenvector_is_computed
Definition: puri_info.h:213
PuriInfo::get_vec_mixed_norms
void get_vec_mixed_norms(std::vector< real > &norms)
Definition: puri_info.cc:155
IterationInfo::constantC
real constantC
Definition: puri_info.h:96
PuriInfo::compute_eigenvectors_in_this_SCF_cycle
bool compute_eigenvectors_in_this_SCF_cycle
Definition: puri_info.h:211
PuriInfo::get_total_nnz_time
real get_total_nnz_time()
Definition: puri_info.cc:64
IterationInfo::gap
real gap
Definition: puri_info.h:82
PuriInfo::get_total_eucl_diff_time
real get_total_eucl_diff_time()
Definition: puri_info.cc:80
PuriInfo::set_spectrum_bounds
void set_spectrum_bounds(const real lower_spectrum_bound_, const real upper_spectrum_bound_)
Definition: puri_info.cc:181
PuriInfo::time_spectrum_bounds
real time_spectrum_bounds
Definition: puri_info.h:195
IterationInfo::trace_diff_time
double trace_diff_time
Definition: puri_info.h:64
IterationInfo::XmX2_fro_norm
real XmX2_fro_norm
Definition: puri_info.h:76
IterationInfo::commutation_error
real commutation_error
Definition: puri_info.h:92
do_output
void do_output(int logCategory, int logArea, const char *format,...)
Definition: output.cc:53
IterationInfo::homo_eig_solver_time
double homo_eig_solver_time
Definition: puri_info.h:73
PuriInfo::PuriInfo
PuriInfo()
Definition: puri_info.h:145
PuriInfo::get_total_inf_diff_time
real get_total_inf_diff_time()
Definition: puri_info.cc:73
PuriInfo::lumo_eigensolver_iter
int lumo_eigensolver_iter
Definition: puri_info.h:217
IterationInfo::lumo_eig_solver_time
double lumo_eig_solver_time
Definition: puri_info.h:74
IterationInfo::stopping_criterion_time
double stopping_criterion_time
Definition: puri_info.h:62
PuriInfo::accumulated_error_subspace
real accumulated_error_subspace
Definition: puri_info.h:202
PuriInfo::get_total_trace_diff_time
real get_total_trace_diff_time()
Definition: puri_info.cc:110
IterationInfo::XmX2_trace
real XmX2_trace
Definition: puri_info.h:75
PuriInfo::homo_estim_upp_F
real homo_estim_upp_F
Definition: puri_info.h:206
IterationInfo::nnz_time
double nnz_time
Definition: puri_info.h:67
PuriInfo::accumulated_time_calls_for_eigenvec_functions
real accumulated_time_calls_for_eigenvec_functions
Definition: puri_info.h:204
IterationInfo::NNZ_X2
real NNZ_X2
Definition: puri_info.h:84
PuriInfo::debug_output
int debug_output
Definition: puri_info.h:224
IterationInfo::XmX2_mixed_norm
real XmX2_mixed_norm
Definition: puri_info.h:78
PuriInfo::get_vec_infty_norms
void get_vec_infty_norms(std::vector< real > &norms)
Definition: puri_info.cc:146
output.h
Functionality for writing output messages to a text file.
puri_info.h
File containing classes IterationInfo and PuriInfo. IterationInfo is a class with the information sto...
PuriInfo::get_total_mixed_diff_time
real get_total_mixed_diff_time()
Definition: puri_info.cc:87
IterationInfo::trunc_time
double trunc_time
Definition: puri_info.h:59