9
1
mirror of https://github.com/QuantumPackage/qp2.git synced 2025-02-12 11:44:11 +01:00
Anthony Scemama cf479a80af
Some checks failed
continuous-integration/drone/push Build is failing
Avoid divergence in (T)
2024-04-17 18:06:53 +02:00
..
2023-06-22 18:26:52 +02:00
2023-11-07 10:40:56 +01:00
2021-12-07 19:30:32 +01:00
2024-01-25 22:12:26 +01:00
2024-01-10 11:14:49 +01:00
2023-11-07 10:40:56 +01:00
2024-04-17 18:06:53 +02:00
2024-03-20 16:06:44 +01:00
2024-04-03 16:59:15 +02:00
2023-10-17 23:35:14 +02:00
2023-10-18 00:13:10 +02:00
2022-03-24 16:18:51 +01:00
2023-03-15 10:23:48 +01:00
2023-09-15 11:37:11 +02:00
2023-03-15 10:23:48 +01:00
2024-01-10 11:14:49 +01:00
2023-10-16 16:37:08 +02:00
2024-01-15 12:02:38 +01:00
2022-03-25 09:30:43 +01:00
2024-04-03 16:59:15 +02:00
2023-10-12 16:15:17 +02:00
2024-01-15 19:02:05 +01:00
2024-03-12 15:30:52 +01:00
2023-04-24 00:50:07 +02:00
2023-05-06 20:42:39 +02:00
2023-10-17 17:52:43 +02:00
2024-04-05 14:25:32 +02:00
2023-12-05 17:19:47 +01:00
2023-11-11 16:13:23 +01:00
2024-04-09 12:41:53 +02:00
2023-11-11 16:13:23 +01:00
2024-04-05 14:25:45 +02:00
2024-02-10 12:48:29 +01:00
2023-12-05 17:19:47 +01:00
2023-12-05 17:19:47 +01:00
2023-09-19 14:43:42 +02:00
2024-03-12 17:38:30 +01: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 ...