qp2/src
eginer 7f653b9eee added non_hermit_dav 2022-10-24 11:23:57 +02:00
..
ao_basis merged with Abdallah 2022-09-30 15:27:43 +02:00
ao_many_one_e_ints minor assert fixed 2022-10-22 19:51:56 +02:00
ao_one_e_ints new jast added in QP 2022-10-21 23:27:51 +02:00
ao_tc_eff_map merging 2022-10-22 18:08:56 +02:00
ao_two_e_erf_ints Fixed compile error in previous commit 2020-05-12 19:10:12 +02:00
ao_two_e_ints new jast added in QP 2022-10-21 23:27:51 +02:00
aux_quantities added the definition of the input density in the AO basis 2019-04-09 00:10:01 +02:00
basis minor modifs to merge 2022-09-30 16:22:18 +02:00
basis_correction merged with Abdallah 2022-09-30 15:27:43 +02:00
becke_numerical_grid merged with Abdallah 2022-09-30 15:27:43 +02:00
bi_ort_ints new jast added in QP 2022-10-21 23:27:51 +02:00
bi_ortho_aos added many files and did a lot of documentation for bi-ortho scf 2022-10-05 00:05:22 +02:00
bi_ortho_mos new jast added in QP 2022-10-21 23:27:51 +02:00
bitmask forked v 2022-07-05 01:17:43 +02:00
cas_based_on_top added some stuffs for foboscf 2021-04-08 20:37:17 +02:00
cipsi forked v 2022-07-05 01:17:43 +02:00
cipsi_tc_bi_ortho added cipsi_tc_bi_ortho 2022-10-24 11:14:19 +02:00
cis forked v 2022-07-05 01:17:43 +02:00
cisd merged with Abdallah 2022-09-30 15:27:43 +02:00
cosgtos_ao_int added cosgtos_ao_int 2022-10-23 20:50:14 +02:00
csf forked v 2022-07-05 01:17:43 +02:00
dav_general_mat changed the davidson non sym keyword 2022-10-22 23:00:06 +02:00
davidson minor modifs to merge 2022-09-30 16:22:18 +02:00
davidson_dressed dressing excited states: ok 2022-09-09 10:22:59 +02:00
davidson_keywords added davidson_keywords 2022-10-23 20:51:33 +02:00
davidson_undressed dressing excited states: ok 2022-09-09 10:22:59 +02:00
density_for_dft removed nan in density_for_dft when no beta electrons 2021-03-30 14:58:21 +02:00
determinants minor modifs to merge 2022-09-30 16:22:18 +02:00
dft_keywords added the possibility to have a mu(r) in the functionals 2021-10-07 17:37:24 +02:00
dft_one_e forked v 2022-07-05 01:17:43 +02:00
dft_utils_func merged with Abdallah 2022-09-30 15:27:43 +02:00
dft_utils_in_r forked v 2022-07-05 01:17:43 +02:00
dressing forked v 2022-07-05 01:17:43 +02:00
dummy beginning to reorganise stuffs 2020-04-07 12:19:17 +02:00
electrons Initial commit 2019-01-25 11:39:31 +01:00
ezfio_files forked v 2022-07-05 01:17:43 +02:00
fci Fixing tests 2022-08-29 15:34:48 +02:00
fci_tc_bi added fci_tc_bi 2022-10-05 17:59:23 +02:00
functionals forked v 2022-07-05 01:17:43 +02:00
generators_cas Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
generators_full Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
hartree_fock Reset Huckel guess 2020-12-08 23:18:47 +01:00
iterations forked v 2022-07-05 01:17:43 +02:00
iterations_tc added iterations_tc 2022-10-24 11:14:52 +02:00
kohn_sham Introduced screening.irp.f 2020-05-12 18:48:51 +02:00
kohn_sham_rs forked v 2022-07-05 01:17:43 +02:00
mo_basis forked v 2022-07-05 01:17:43 +02:00
mo_guess forked v 2022-07-05 01:17:43 +02:00
mo_one_e_ints Deactivated banned excitations 2021-06-18 12:47:27 +02:00
mo_two_e_erf_ints forked v 2022-07-05 01:17:43 +02:00
mo_two_e_ints forked v 2022-07-05 01:17:43 +02:00
mpi Initial commit 2019-01-25 11:39:31 +01:00
mu_of_r forked v 2022-07-05 01:17:43 +02:00
non_h_ints_mu it compiles ! 2022-10-22 19:09:22 +02:00
non_hermit_dav added non_hermit_dav 2022-10-24 11:23:57 +02:00
nuclei Fixed floating-point exceptions 2020-05-25 19:22:10 +02:00
perturbation Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
pseudo Fix basis bugs when working on trexio 2021-12-30 14:43:14 +01:00
psiref_cas Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
psiref_utils Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
scf_utils merged with Abdallah 2022-09-30 15:27:43 +02:00
selectors_cassd Warnings in documentation 2019-01-29 17:09:08 +01:00
selectors_full Fixed previous commit 2019-07-02 23:30:36 +02:00
selectors_utils Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
single_ref_method Revert "Replaces psi_det_size by N_det" 2022-05-25 13:35:45 +02:00
some_mu_of_r added tc_keywords and three_body_ints 2022-10-05 17:29:26 +02:00
tc_bi_ortho it woooorks 2022-10-22 20:47:55 +02:00
tc_keywords changed the davidson non sym keyword 2022-10-22 23:00:06 +02:00
tc_scf added tc_scf 2022-10-05 16:04:49 +02:00
three_body_ints added tc_keywords and three_body_ints 2022-10-05 17:29:26 +02:00
tools forked v 2022-07-05 01:17:43 +02:00
two_body_rdm forked v 2022-07-05 01:17:43 +02:00
two_rdm_routines forked v 2022-07-05 01:17:43 +02:00
utils added tc_scf 2022-10-05 16:04:49 +02:00
utils_periodic Slowly merging periodic in dev 2020-03-18 16:35:41 +01:00
zmq Protection of writes in openmp 2021-06-18 12:48:07 +02:00
README.rst renaming in functionals/sr_pbe.irp.f 2020-04-02 16:24:33 +02:00

README.rst

==========================
The core modules of the QP
==========================

*** How are handled the DFT functionals in QP2 ?
================================================
    The Exchange and Correlation energies/potentials can be accessed by the following providers 
    energy_x
    energy_c
    potential_x_alpha_ao
    potential_c_alpha_ao
    potential_x_beta_ao
    potential_c_beta_ao

    These providers are automatically linked to the providers of the actual exchange/correlation energies of a given functional 
    through the character keywords 
    "exchange_functional"
    "correlation_functional"

    All the providers for the available functionals are in the folder "functionals", with one file "my_functional.irp.f" per functional.  

    Ex : if "exchange_functional" == "sr_pbe", then energy_x will contain the exchange correlation functional defined in "functiona/sr_pbe.irp.f", which corresponds to the short-range PBE functional (at the value mu_erf for the range separation parameter) 


*** How to add a new functional in QP2 
======================================

    Creating a new functional and propagating it through the whole QP2 programs is easy as all dependencies are handled by a script. 

    To do so, let us assume that the name of your functional is "my_func". 
    Then you just have to create the file "my_func.irp.f" in the folder "functional" which shoud contain 

    +) if you're adding an exchange functional, then create the provider "energy_x_my_func" 

    +) if you're adding a correlation functional, create the provider "energy_c_my_func" 
    
    +) if you want to add the echange potentials, create the providers "potential_x_alpha_ao_my_func", "potential_x_beta_ao_my_func"  which are the exchange potentials on the AO basis for the alpha/beta electrons 

    +) if you want to add the correlation potentials, create the providers "potential_c_alpha_ao_my_func", "potential_c_beta_ao_my_func"  which are the correlation potentials on the AO basis for the alpha/beta electrons 
    
    That's all :) 
   
    Then, when running whatever DFT calculation or accessing/using the providers: 
    energy_x
    energy_c
    potential_x_alpha_ao
    potential_c_alpha_ao
    potential_x_beta_ao
    potential_c_beta_ao
 
    if exchange_functional = mu_func, then you will automatically have access to what you need, such as kohn sham orbital optimization and so on ...