Options Class Reference

Options Class Reference#

LibRPA: librpa::Options Class Reference
LibRPA
librpa::Options Class Reference

C++ wrapper for runtime options. More...

#include <librpa.hpp>

Inheritance diagram for librpa::Options:
Collaboration diagram for librpa::Options:

Public Member Functions

 Options ()
 Construct with default options.
 
void set_output_dir (const char *output_dir)
 Set output directory.
 

Additional Inherited Members

- Public Attributes inherited from LibrpaOptions
char output_dir [LIBRPA_MAX_STRLEN]
 Output directory.
 
LibrpaParallelRouting parallel_routing
 Scheme of parallelization.
 
LibrpaVerbose output_level
 Verbose level for output.
 
double vq_threshold
 Threshold for real-space Coulomb matrices.
 
LibrpaSwitch use_kpara_scf_eigvec
 Flag to specify parallel distribution of eigenvectors of SCF starting point.
 
LibrpaTimeFreqGrid tfgrids_type
 Type of time/frequency grids.
 
int nfreq
 Number of time/frequency points.
 
double tfgrids_freq_min
 Minimum frequency for grid generation, in Hartree.
 
double tfgrids_freq_interval
 Frequency interval for even-spaced grids, in Hartree.
 
double tfgrids_freq_max
 Maximum frequency for grid generation, in Hartree.
 
double tfgrids_time_min
 Minimum time for grid generation, in Hartree^-1.
 
double tfgrids_time_interval
 Time interval for even-spaced grids, in Hartree^-1.
 
double minimax_emin
 Minimal transition energy when generating minimax grids.
 
double minimax_emax
 Maximal transition energy when generating minimax grids.
 
double minimax_regulation
 Regulation for minimax grids generation.
 
LibrpaSwitch use_fullcoul_exx
 Switch of using full Coulomb interaction in exact-exchange operator.
 
LibrpaSwitch use_fullcoul_eps
 Switch of using full Coulomb interaction in \(\varepsilon = 1 - v \chi^0\).
 
LibrpaSwitch use_fullcoul_wc
 Switch of using full Coulomb interaction in \(W^c = (\varepsilon^{-1} - 1) v\).
 
int n_bands_chi0
 Maximal number of bands for computing response function.
 
int n_bands_sigc
 Maximal number of bands for computing correlation self-energy.
 
double gf_threshold
 Threshold for real-space Green's function in response function calculation.
 
LibrpaSwitch use_scalapack_ecrpa
 Flag to control whether to use ScaLAPACK to compute RPA correlation energy.
 
LibrpaSwitch use_shrink_abfs
 Flag to use a compressed auxiliary basis.
 
LibrpaSwitch use_shrink_chi
 Flag to compress response function using shrinked basis.
 
int n_params_anacon
 Number of parameters for analytic continuation.
 
LibrpaSwitch use_scalapack_gw_wc
 Flag of using ScaLAPACK for computing Wc from chi0.
 
LibrpaSwitch use_cholesky_gw_wc
 Flag of using cholesky factorization for computing Wc from chi0.
 
LibrpaSwitch replace_w_head
 Flag of replacing head of screened interaction by macroscopic dielectric function.
 
int option_dielect_func
 Option of computing dielectric function on imaginary axis.
 
LibrpaSwitch use_2d_dielectric
 Switch of using 2D dielectric function.
 
LibrpaSwitch load_sigc_from_file
 Flag of loading correlation self-energy matrix (real-space, imaginary frequency) from file.
 
double sqrt_coulomb_threshold
 Threshold of eigenvalues to perform square root of Coulomb matrices.
 
double libri_chi0_threshold_C
 Threshold of real-space LRI triple coefficients to compute response function using LibRI.
 
double libri_chi0_threshold_G
 Threshold of real-space Green's function to compute response function using LibRI.
 
double libri_exx_threshold_C
 Threshold of real-space LRI triple coefficients to compute exact exchange using LibRI.
 
double libri_exx_threshold_D
 Threshold of real-space density matrices to compute exact exchange using LibRI.
 
double libri_exx_threshold_V
 Threshold of real-space Coulomb matrices to compute exact exchange using LibRI.
 
double libri_g0w0_threshold_C
 Threshold of real-space LRI triple coefficients to compute GW correlation self-energy using LibRI.
 
double libri_g0w0_threshold_G
 Threshold of real-space Green's function to compute GW correlation self-energy using LibRI.
 
double libri_g0w0_threshold_Wc
 Threshold of correlation screened Coulomb matrix to compute GW correlation self-energy using LibRI.
 
LibrpaSwitch output_gw_sigc_mat
 Output correlation self-energy matrix (reciprocal space, imaginary frequency domain)
 
LibrpaSwitch output_gw_sigc_mat_rt
 Output correlation self-energy matrix in NAO (real space, imaginary time domain)
 
LibrpaSwitch output_gw_sigc_mat_rf
 Output correlation self-energy matrix in NAO (real space, imaginary frequency domain)
 
int option_output_Wc_Rf_mat
 Switch of outputting Wc matrix in Abs (real space, imaginary frequency domain)
 

Detailed Description

C++ wrapper for runtime options.

Provides a convenient C++ interface to LibrpaOptions with constructor initialization and setter methods.

Note
Straightforward inheritance. DO NOT add extra member variables here, which will break the inherited data layout. New control options should be put under the LibrpaOptions C structure.

Member Function Documentation

◆ set_output_dir()

void librpa::Options::set_output_dir ( const char * output_dir)
inline

Set output directory.

Parameters
[in]output_dirPath for output data files.
Here is the call graph for this function:

The documentation for this class was generated from the following file: