9
1
mirror of https://github.com/QuantumPackage/qp2.git synced 2024-07-15 15:34:32 +02:00
qp2/src
eginer c341718982
Some checks failed
continuous-integration/drone/push Build is failing
fixed the 10.hf.bats
2023-02-07 13:23:00 +01:00
..
ao_basis Remove debug 2022-03-16 10:26:18 +01:00
ao_one_e_ints point charges work 2023-02-07 12:50:33 +01:00
ao_two_e_erf_ints Fixed compile error in previous commit 2020-05-12 19:10:12 +02:00
ao_two_e_ints added one_e_dm_ao 2021-09-20 14:04:09 +02:00
aux_quantities added the definition of the input density in the AO basis 2019-04-09 00:10:01 +02:00
basis Update for TREXIOv2 2021-12-07 19:30:32 +01:00
basis_correction added the possibility to have a pure active space interaction 2021-09-13 14:38:00 +02:00
becke_numerical_grid FIxed bug in CSF 2022-02-04 11:09:33 +01:00
bitmask moved a subroutine from determinant to bitmask 2021-12-17 18:15:47 +01:00
cas_based_on_top added some stuffs for foboscf 2021-04-08 20:37:17 +02:00
cipsi correction 2022-04-13 13:32:14 +02:00
cis add excitation energies in eV 2022-03-28 20:08:35 +02:00
cisd Fixing tests 2022-08-29 15:45:09 +02:00
csf remove print 2022-03-24 16:18:51 +01:00
dav_general_mat Fix compilation with gfortran 2022-11-01 10:21:36 +01:00
davidson Accelerated PT2 2022-03-08 11:24:17 +01:00
davidson_dressed Dressed davidson with CSF 2022-01-28 20:16:01 +01:00
davidson_undressed Initial commit 2019-01-25 11:39:31 +01:00
density_for_dft removed nan in density_for_dft when no beta electrons 2021-03-30 14:58:21 +02:00
determinants Fix normalization in qp_edit 2022-09-15 18:12:27 +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 Merge branch 'cleaning_dft' of https://github.com/QuantumPackage/qp2 into cleaning_dft 2021-11-09 15:48:58 +01:00
dft_utils_func Added grad_rho 2021-11-09 15:48:49 +01:00
dft_utils_in_r fixed bug in Laplacians 2022-01-25 18:20:03 +01:00
dressing Fixed tooth_width=0.0 2022-03-25 09:30:43 +01: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 Improving PT2 2022-03-09 10:23:27 +01:00
fci Fixing tests 2022-08-29 15:45:09 +02:00
functionals added the possibility to have a mu(r) in the functionals 2021-10-07 17:37:24 +02:00
generators_cas Fixed small bugs 2019-06-27 23:46:30 +02:00
generators_full Initial commit 2019-01-25 11:39:31 +01:00
hartree_fock fixed the 10.hf.bats 2023-02-07 13:23:00 +01:00
iterations removed some stuffs to clean the CIPSI module 2021-10-18 08:56:25 +02:00
kohn_sham Introduced screening.irp.f 2020-05-12 18:48:51 +02:00
kohn_sham_rs Added grad_rho 2021-11-09 15:48:49 +01:00
mo_basis added dav_dressed_ext_rout.irp.f 2021-09-28 00:30:10 +02:00
mo_guess removed bug in subroutine of dav_general_mat 2022-01-20 20:10:50 +01:00
mo_one_e_ints Deactivated banned excitations 2021-06-18 12:47:27 +02:00
mo_two_e_erf_ints minor changes 2021-03-15 17:40:37 +01:00
mo_two_e_ints removed stupid assert 2021-11-05 15:17:39 +01:00
mpi Initial commit 2019-01-25 11:39:31 +01:00
mu_of_r added the possibility to have a pure active space interaction 2021-09-13 14:38:00 +02:00
nuclei point charges work 2023-02-07 12:50:33 +01:00
perturbation Global Replacement of 'occupation pattern' with 'configuration' 2020-12-22 00:55:14 +01:00
pseudo Fix basis bugs when working on trexio 2021-12-30 14:43:14 +01:00
psiref_cas Initial commit 2019-01-25 11:39:31 +01:00
psiref_utils Initial commit 2019-01-25 11:39:31 +01:00
scf_utils added some orbitals freezing in scf utils 2021-05-10 01:31:34 +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 Initial commit 2019-01-25 11:39:31 +01:00
single_ref_method Initial commit 2019-01-25 11:39:31 +01:00
tools output print dipole for n_states >= 1 + read_wf true 2022-03-16 11:42:26 +01:00
two_body_rdm Documentation 2022-01-11 11:25:48 +01:00
two_rdm_routines Removed debug prints 2021-12-10 18:43:05 +01:00
utils Improving PT2 2022-03-09 10:23:27 +01: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

==========================
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 ...