librpa_options.h Source File

librpa_options.h Source File#

LibRPA: librpa_options.h Source File
LibRPA
librpa_options.h
Go to the documentation of this file.
1#pragma once
9
10#include "librpa_enums.h"
11
12// C APIs
13#ifdef __cplusplus
14extern "C" {
15#endif
16
18#define LIBRPA_MAX_STRLEN 200
19
20// NOTE: in case the data layout of LibrpaOptions is changed,
21// its Fortran binding should be adapted accordingly.
22
34typedef struct
35{
36 /* ============================================================================= */
37 /* Common runtime control */
38
46
56
58
65
70
77
79
89
93 int nfreq;
94
95 /* ============================================================================= */
96 /* Parameters for time and freqeuncy grids.
97 * Different grid types will use none/part/all of the parameters. */
102
107
112
117
122
124
135
137
146
153
154 /* ============================================================================= */
155 /* Coulomb matrices usage */
156
161
168
176
183
190
197
204
205 /* ============================================================================= */
206 /* Sum of states */
207
214
221
230
239
241
251
252 /* ============================================================================= */
253 /* RPA specific */
254
256
275
280
287
294
299
300 /* ============================================================================= */
301 /* ABF compression */
302
309
316
317 /* ============================================================================= */
318 /* GW specific */
319
325
330
335
340
345
356
358
368
370
382
384
394
399
404
410
415
423
430
446
457
464
471
476
483
490
497
502
504
531
544
554
568
572
577
578 /* ============================================================================= */
579 /* LibRI related */
580
585
590
595
600
605
610
615
620
621 /* Output controls */
628
635
642
656
683
692
700
712
719
732
739
746
753
760
762
772
779void librpa_set_output_dir(LibrpaOptions *opts, const char *output_dir);
780
787void librpa_set_restart_from_dir(LibrpaOptions *opts, const char *restart_from_dir);
788
792typedef struct
793{
794 int min_iterations, max_iterations, unoccupied_keep, cut_mode;
798 double mixing_beta, cut_shift_ha, convergence_tolerance_ev;
799 const char *mixer, *velocity_mode, *restart_file, *checkpoint_file;
800 int output_matrices, output_qp, export_hamiltonian;
801 int state_low, state_high, interband_velocity;
816
823
827 typedef struct
828 {
829 int interval, track_orbitals, output_analysis;
830 const char* tracking_definition;
832
833 void librpa_init_qsgw_crpa_controls(LibrpaQsgwCrpaControls* controls);
834
835#ifdef __cplusplus
836}
837#endif
Enumeration types and constants for LibRPA.
LibrpaMethod
Method to compute a quantity on the time/frequency grid.
Definition librpa_enums.h:126
int LibrpaSwitch
Boolean switch type.
Definition librpa_enums.h:138
LibrpaAnalyContMethod
Analytic continuation method for GW and QSGW.
Definition librpa_enums.h:114
LibrpaParallelRouting
Parallel routing strategy for distributed memory calculations.
Definition librpa_enums.h:83
LibrpaTimeFreqGrid
Type of time or frequency grid for integration.
Definition librpa_enums.h:101
void librpa_set_output_dir(LibrpaOptions *opts, const char *output_dir)
Set the output directory for LibRPA results.
void librpa_init_qsgw_controls(LibrpaQsgwControls *)
void librpa_set_restart_from_dir(LibrpaOptions *opts, const char *restart_from_dir)
Set the directory to read restart checkpoint files from.
#define LIBRPA_MAX_STRLEN
Definition librpa_options.h:18
void librpa_init_options(LibrpaOptions *opts)
Initialize runtime options to default values.
Runtime options structure for LibRPA calculations.
Definition librpa_options.h:35
LibrpaSwitch use_gpu_replace_scalapack
Definition librpa_options.h:489
LibrpaSwitch use_symmetry_rpa
Definition librpa_options.h:196
LibrpaSwitch output_wc_rf_atom_pair
Definition librpa_options.h:745
int qpe_solver_n_iter_max
Definition librpa_options.h:403
LibrpaSwitch output_gw_sigc_ks_mat_kf
Definition librpa_options.h:634
double sf_sigc_omega_shift
Definition librpa_options.h:470
int istate_ref_hedin_shift
Definition librpa_options.h:456
LibrpaSwitch use_symmetry_exx
Definition librpa_options.h:182
double libri_g0w0_threshold_G
Definition librpa_options.h:614
LibrpaTimeFreqGrid anacon_tfgrids_type
Type of optional frequency grid used for GW analytic continuation.
Definition librpa_options.h:367
LibrpaParallelRouting parallel_routing
Scheme of parallelization.
Definition librpa_options.h:64
double libri_chi0_threshold_C
Definition librpa_options.h:584
int ifreq_output_wc_end
Definition librpa_options.h:759
int n_bands_sigc
Definition librpa_options.h:220
int istate_output_mat_start
Definition librpa_options.h:691
LibrpaSwitch output_gw_sigc_ks_kf
Definition librpa_options.h:627
LibrpaSwitch replace_w_head
Definition librpa_options.h:501
double tfgrids_freq_min
Definition librpa_options.h:101
int option_dielect_func
Option of computing dielectric function on imaginary axis.
Definition librpa_options.h:530
double libri_chi0_threshold_G
Definition librpa_options.h:589
double sf_gf_omega_shift
Definition librpa_options.h:463
LibrpaSwitch output_abacus_gw_gf
Definition librpa_options.h:203
LibrpaSwitch use_fullcoul_exx
Definition librpa_options.h:160
double qpe_solver_damp_factor
Definition librpa_options.h:409
LibrpaSwitch use_scalapack_ecrpa
Definition librpa_options.h:298
int option_qpe_solver
Quasi-particle equation solver option.
Definition librpa_options.h:393
int n_params_anacon_resample
Definition librpa_options.h:355
double tfgrids_freq_interval
Definition librpa_options.h:106
double vq_threshold
Definition librpa_options.h:69
LibrpaSwitch use_fullcoul_eps
Definition librpa_options.h:167
double minimax_emax
Maximal transition energy when generating minimax grids.
Definition librpa_options.h:145
int anacon_nfreq
Number of points in the optional GW analytic-continuation frequency grid.
Definition librpa_options.h:381
double anacon_aaa_tolerance
Definition librpa_options.h:329
double tfgrids_freq_max
Definition librpa_options.h:111
LibrpaSwitch use_scalapack_gw_wc
Definition librpa_options.h:475
LibrpaSwitch read_sigc_mat_rf
Definition librpa_options.h:567
LibrpaSwitch output_gw_sigc_mat_rf
Definition librpa_options.h:731
int nfreq
Definition librpa_options.h:93
char restart_from_dir[LIBRPA_MAX_STRLEN]
Definition librpa_options.h:55
char rpa_headwing_mode[LIBRPA_MAX_STRLEN]
Definition librpa_options.h:571
LibrpaSwitch use_elpa_sqrt_coulomb
Definition librpa_options.h:496
LibrpaSwitch output_gw_sigc_mat_rt
Definition librpa_options.h:718
LibrpaSwitch use_qpe_legacy_update
Definition librpa_options.h:422
double libri_g0w0_threshold_Wc
Definition librpa_options.h:619
double gf_threshold
Definition librpa_options.h:279
char output_dir[LIBRPA_MAX_STRLEN]
Definition librpa_options.h:45
double sqrt_coulomb_threshold
Definition librpa_options.h:576
LibrpaAnalyContMethod anacon_method
Definition librpa_options.h:324
LibrpaSwitch output_wc_rf
Definition librpa_options.h:738
double libri_exx_threshold_V
Definition librpa_options.h:604
double tfgrids_time_min
Definition librpa_options.h:116
LibrpaSwitch use_symmetry_gw
Definition librpa_options.h:189
double anacon_ridge_den_weight
Definition librpa_options.h:339
LibrpaSwitch use_shrink_abfs
Definition librpa_options.h:308
double qpe_solver_thres
Definition librpa_options.h:398
int istate_output_mat_end
Definition librpa_options.h:699
double libri_g0w0_threshold_C
Definition librpa_options.h:609
LibrpaSwitch use_hedin_shift
Definition librpa_options.h:445
LibrpaMethod chi0_method
Method to compute the response function chi0.
Definition librpa_options.h:274
LibrpaSwitch use_2d_dielectric
Definition librpa_options.h:543
LibrpaSwitch output_exx_ks_mat_k
Definition librpa_options.h:641
double tfgrids_time_interval
Definition librpa_options.h:121
LibrpaSwitch output_exx_mat_r
Definition librpa_options.h:682
double minimax_emin
Minimal transition energy when generating minimax grids.
Definition librpa_options.h:134
int rpa_headwing_body_start
Definition librpa_options.h:553
int ifreq_output_wc_start
Definition librpa_options.h:752
LibrpaSwitch output_gw_sigc_mat_kf
Definition librpa_options.h:711
double anacon_ridge_lambda
Definition librpa_options.h:334
double libri_exx_threshold_C
Definition librpa_options.h:594
int n_bands_chi0
Definition librpa_options.h:213
int option_bvk_remap
BvK remapping convention for band interpolation.
Definition librpa_options.h:250
double minimax_regulation
Definition librpa_options.h:152
int libri_chi0_collect_s0_chunk
Definition librpa_options.h:286
LibrpaSwitch use_qpe_adaptive_damp
Definition librpa_options.h:414
LibrpaTimeFreqGrid tfgrids_type
Type of time/frequency grids.
Definition librpa_options.h:88
long long libri_chi0_collect_max_bytes
Definition librpa_options.h:293
LibrpaSwitch output_exx_mat_k
Definition librpa_options.h:655
LibrpaSwitch use_fullcoul_wc
Definition librpa_options.h:175
double libri_exx_threshold_D
Definition librpa_options.h:599
LibrpaSwitch use_shrink_chi
Definition librpa_options.h:315
int n_params_anacon
Definition librpa_options.h:344
LibrpaSwitch use_kpara_scf_eigvec
Definition librpa_options.h:76
LibrpaSwitch override_qpe_solver_nan
Definition librpa_options.h:429
int n_bands_exclude_chi0
Definition librpa_options.h:229
int n_bands_exclude_sigc
Definition librpa_options.h:238
LibrpaSwitch use_cholesky_gw_wc
Definition librpa_options.h:482
Definition librpa_options.h:793
int expand_ibz
Definition librpa_options.h:811
int update_hartree
Definition librpa_options.h:814
double mixing_beta
Definition librpa_options.h:798
Definition librpa_options.h:828